RetailRichMediaEncoder Class [AX 2012]

  • Article

Provides methods to encode into and decode from the special format in which a list of media is stored as a text.

A list of media is encoded into a xml format as follows http://bing.comThe Bing images ^\^http://www.contoso.comContoso Inc. ^\\go\there\^ and see!

Syntax

class RetailRichMediaEncoder

Run On

Called

Methods

  Method Description
JJ802611.pubmethod(en-us,AX.60).gif cancelTimeOut Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
JJ802611.pubmethod(en-us,AX.60).gif equal Determines whether the specified object is equal to the current one. (Inherited from Object.)
JJ802611.pubmethod(en-us,AX.60).gif getTimeOutTimerHandle Returns the timer handle for the object. (Inherited from Object.)
JJ802611.pubmethod(en-us,AX.60).gif handle Retrieves the handle of the class of the object. (Inherited from Object.)
JJ802611.pubmethod(en-us,AX.60).gif new Initializes a new instance of the Object class. (Inherited from Object.)
JJ802611.pubmethod(en-us,AX.60).gif notify Releases the hold on an object that has called the wait method on this object. (Inherited from Object.)
JJ802611.pubmethod(en-us,AX.60).gif notifyAll Releases a lock on the object that was issued by the wait method on this object. (Inherited from Object.)
JJ802611.pubmethod(en-us,AX.60).gif objectOnServer Determines whether the object is on a server. (Inherited from Object.)
JJ802611.pubmethod(en-us,AX.60).gif owner Returns the instance that owns the object. (Inherited from Object.)
JJ802611.pubmethod(en-us,AX.60).gif setTimeOut Sets up the scheduled execution of a specified method. (Inherited from Object.)
JJ802611.pubmethod(en-us,AX.60).gif toString Returns a string that represents the current object. (Inherited from Object.)
JJ802611.pubmethod(en-us,AX.60).gif usageCount Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
JJ802611.pubmethod(en-us,AX.60).gif wait Pauses a process. (Inherited from Object.)
JJ802611.pubmethod(en-us,AX.60).gif xml Returns an XML string that represents the current object. (Inherited from Object.)
JJ802611.privmethod(en-us,AX.60).gif JJ802611.static(en-us,AX.60).gif ::appendRecord
JJ802611.pubmethod(en-us,AX.60).gif JJ802611.static(en-us,AX.60).gif ::Decode Decodes a list of medias from the supplied string representation into the supplied RetailRichMediaTmp table.The method returns the id of the first media record.For the information on the encoding format, please see the class description.
JJ802611.pubmethod(en-us,AX.60).gif JJ802611.static(en-us,AX.60).gif ::Encode Encodes the supplied RetailRichMediaTmp table with a list of media into a string putting the record with the id of _defaultRecId first.The method will not include the 'Alt text' field, if supplied _mediaType is Videos.For the information on the encoding format, please see the class description.
JJ802611.pubmethod(en-us,AX.60).gif JJ802611.static(en-us,AX.60).gif ::EncodeValues Encodes the supplied values for _url and _altText and formats them as an xml string.The method will add a emoty value for 'Alt text' field, if supplied _altText is not send.For the information on the encoding format, please see the class description.

Top

Remarks

The xml header is removed due to BP violations, but it will be present in the output with utf-8 encoding

Inheritance Hierarchy

Object Class
  RetailRichMediaEncoder Class