RetailMediaChannelConnector Interface [AX 2012]

The RetailMediaChannelConnector interface is to be implemented by classes that allow to set up a link, post messages and upload supplimentary images to services as Facebook, Twitter and the like.

Syntax

interface RetailMediaChannelConnector

Run On

Called

Methods

	Method	Description
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	finishOAuth	The finishOAuth method is called to finialize the authentication process
	getLoginURl	The getLoginURI method is called to get the URI to direct the user to to sign in and grant the access to the application
	getTimeOutTimerHandle	Returns the timer handle for the object. (Inherited from Object.)
	handle	Retrieves the handle of the class of the object. (Inherited from Object.)
	new	Initializes a new instance of the Object class. (Inherited from Object.)
	notify	Releases the hold on an object that has called the wait method on this object. (Inherited from Object.)
	notifyAll	Releases a lock on the object that was issued by the wait method on this object. (Inherited from Object.)
	objectOnServer	Determines whether the object is on a server. (Inherited from Object.)
	owner	Returns the instance that owns the object. (Inherited from Object.)
	processLoginResponse	This method is called when user is signing in and the web-browser detects new pages opened, This mau be used to check if the page opened is the final page in the sign in process.
	push	The push method is called to post a message to the service
	setTimeOut	Sets up the scheduled execution of a specified method. (Inherited from Object.)
	startOAuth	The startOAuth method is called to initiate authentication process and retrieve intial set of OAuth parameters
	toString	Returns a string that represents the current object. (Inherited from Object.)
	uploadPhoto	The uploadPhoto method is called when image needs to be uploaded to the service, if it is a separate operation from posting a message.
	usageCount	Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
	wait	Pauses a process. (Inherited from Object.)
	xml	Returns an XML string that represents the current object. (Inherited from Object.)

Top

Remarks

Authentication The interface have method that are called during sign in or authentication process.

Two types of authentication processes are supported: 1-legged and 3-legged authentication processes.

In 3-legged authentication process the interface methods are called in the following order: 1. startOAuth method is called to initiate the authentication process and retrieve intial set of OAuth parameters.

2.1 getLoginURI method is called to get the URI to direct the user to to sign in and grant the access to the application 2.2 processLoginResponse method may be called several time - every time user get redirected to new page - during the sing in process.

3. finishOAuth method is called to finialize the authentication process Twitter uses 3-legged authentication process.

In case of 1-legged authentication process the interface methods are called in the following order: 1.1 getLoginURI method is called to get the URI to direct the user to to sign in and grant the access to the application 1.2 processLoginResponse method may be called several time - every time user get redirected to new page - during the sing in process.

Facebook uses 1-legged authentication process.

Inheritance Hierarchy

Object Class
  RetailMediaChannelConnector Interface