Class: InteractionMedia

Constructor

new InteractionMedia(workService)

Constructor function for Interaction Media Model

Parameters:
Name Type Description
workService AvayaCustomerServices.Services.Work.WorkService

Members

attachments :Array.<object>

Array of attachments belonging to this Interaction Media

Type:
  • Array.<object>

data :object

Generic object in which to store model data

Type:
  • object
Inherited From:

id :string

A unique identifier for this model instance

Type:
  • string
Inherited From:

interactionId :string

Unique identifier for Interaction

Type:
  • string

isNew :boolean

Flag to indicate if model instance is new

Type:
  • boolean
Inherited From:

messages :Array.<object>

Array of messages belonging to this Interaction Media

Type:
  • Array.<object>

notifications :Array.<object>

Array of notifications belonging to this Interaction Media

Type:
  • Array.<object>

participants :Array.<object>

Array of participants involved in Interaction

Type:
  • Array.<object>

Methods

addIsTypingCallback(callback)

Adds a callback that is executed when participant begins to type a new message

Parameters:
Name Type Description
callback AvayaCustomerServices.Services.Work.InteractionMedia~onIsTypingCallback

Function that handles on interaction media is typing event response

addMessageReceivedCallback(callback)

Adds a callback that is executed when interaction media message has been created

Parameters:
Name Type Description
callback AvayaCustomerServices.Services.Work.InteractionMedia~onMessageReceivedCallback

Function that handles on interaction media message added event response

addOnAttachmentAddedCallback(callback)

Adds a callback that is executed when interaction media attachment has been added

Parameters:
Name Type Description
callback AvayaCustomerServices.Services.Work.InteractionMedia~onAttachmentAddedCallback

Function that handles on interaction media attachment added event response

addOnAttachmentRemovedCallback(callback)

Adds a callback that is executed when interaction media attachment has been removed

Parameters:
Name Type Description
callback AvayaCustomerServices.Services.Work.InteractionMedia~onAttachmentRemovedCallback

Function that handles on interaction media attachment removed event response

addOnConnectedCallback(callback)

Adds a callback that is executed when interaction media has been (re)connected

Parameters:
Name Type Description
callback AvayaCustomerServices.Services.Work.InteractionMedia~onConnectedCallback

Function that handles on interaction media connected event response

addOnCustomerDownloadCompleteCallback(callback)

Adds a callback that is executed when a customer completes a file transfer (download)

Parameters:
Name Type Description
callback AvayaCustomerServices.Services.Work.InteractionMedia~onCustomerDownloadCompleteCallback

Function that handles on interaction media customer download complete event response

Since:
  • 3.2.2

addOnCustomerDownloadInitiatedCallback(callback)

Adds a callback that is executed when a customer initiates a file transfer (download)

Parameters:
Name Type Description
callback AvayaCustomerServices.Services.Work.InteractionMedia~onCustomerDownloadInitiatedCallback

Function that handles on interaction media customer download initiated event response

Since:
  • 3.2.2

addOnDisconnectedCallback(callback)

Adds a callback that is executed when interaction media has been disconnected

Parameters:
Name Type Description
callback AvayaCustomerServices.Services.Work.InteractionMedia~onDisconnectedCallback

Function that handles on interaction media disconnected event response

addOnDoNotForwardStatusChangedCallback(callback)

Parameters:
Name Type Description
callback AvayaCustomerServices.Services.Work.InteractionMedia~addOnDoNotForwardStatusChangedCallback

addOnEmailFileLimitExceededCallback(callback)

Adds a callback that is executed when email's file size limit has been exceeded

Parameters:
Name Type Description
callback AvayaCustomerServices.Services.Work.InteractionMedia~onEmailFileLimitExceededCallback

Function that handles on interaction media email file limit exceeded event response

addOnFileTransferredCallback(callback)

Adds a callback that is executed when a file has been uploaded for transfer

Parameters:
Name Type Description
callback AvayaCustomerServices.Services.Work.InteractionMedia~onFileTransferredCallback

Function that handles on interaction media file transferred event response

Since:
  • 3.2.2

addOnForwardSentCallback(callback)

Adds a callback that is executed when forward email has been sent

Parameters:
Name Type Description
callback AvayaCustomerServices.Services.Work.InteractionMedia~onForwardSentCallback

Function that handles on interaction media forward sent event response

addOnHasAttachementStatusChangedCallback(callback)

Parameters:
Name Type Description
callback AvayaCustomerServices.Services.Work.InteractionMedia~addOnHasAttachmentStatusChangedCallback

addOnImportanceChangedCallback(callback)

Parameters:
Name Type Description
callback AvayaCustomerServices.Services.Work.InteractionMedia~addOnImportanceChangedCallback

addOnIsReadStatusChangedCallback(callback)

Parameters:
Name Type Description
callback AvayaCustomerServices.Services.Work.InteractionMedia~addOnIsReadStatusChangedCallback

addOnMessagesReceivedCallback(callback)

Adds a callback that is executed when interaction media messages has been created

Parameters:
Name Type Description
callback AvayaCustomerServices.Services.Work.InteractionMedia~onMessagesReceivedCallback

Function that handles on interaction media messages added event response

addOnPagePushUrlCallback(callback)

Adds a callback that is executed when interaction media page push URL has been created

Parameters:
Name Type Description
callback AvayaCustomerServices.Services.Work.InteractionMedia~onPagePushUrlCallback

Function that handles on interaction media page push URL event response

addOnParticipantAddedCallback(callback)

Adds a callback that is executed when participant has joined interaction media

Parameters:
Name Type Description
callback AvayaCustomerServices.Services.Work.InteractionMedia~onParticipantAddedCallback

Function that handles on interaction media participant added event response

addOnParticipantRemovedCallback(callback)

Adds a callback that is executed when participant has left interaction media

Parameters:
Name Type Description
callback AvayaCustomerServices.Services.Work.InteractionMedia~onParticipantRemovedCallback

Function that handles on interaction media participant removed event response

addOnParticipantsListedCallback(callback)

Adds a callback that is executed when participants are retrieved from server

Parameters:
Name Type Description
callback AvayaCustomerServices.Services.Work.InteractionMedia~onParticipantsListedCallback

Function that handles on interaction media participants listed event response

addOnSensitivityChangedCallback(callback)

Parameters:
Name Type Description
callback AvayaCustomerServices.Services.Work.InteractionMedia~addOnSensitivityChangedCallback

addOnTypeChangedCallback(callback)

Parameters:
Name Type Description
callback AvayaCustomerServices.Services.Work.InteractionMedia~addOnTypeChangedCallback

applyDraftAttachments() → {AvayaCustomerServices.Base.Promise}

Since:
  • 3.5.0.0
Returns:
{ AvayaCustomerServices.Base.Promise }

applyForwardAttachments() → {AvayaCustomerServices.Base.Promise}

Since:
  • 3.6.1.0
Returns:
{ AvayaCustomerServices.Base.Promise }

getAttachments() → {Array.<object>}

Get all the attachments belonging to this Interaction Media

Returns:
{ Array.<object> }

Array of Interaction Media Attachments

getParticipants() → {Array.<object>}

Get all the participants belonging to this Interaction Media

Returns:
{ Array.<object> }

Array of Interaction Media participants

removeAttachments(attachmentId) → {AvayaCustomerServices.Base.Promise}

Parameters:
Name Type Argument Description
attachmentId string <optional>

ID of attachment to remove

Since:
  • 3.3.0.0
Returns:
{ AvayaCustomerServices.Base.Promise }

reportTyping(sensitivity) → {AvayaCustomerServices.Base.Promise}

Sends an interaction media report typing message

Parameters:
Name Type Description
sensitivity string

Sensitivity of message been sent

Returns:
{ AvayaCustomerServices.Base.Promise }

send(message, sensitivity) → {AvayaCustomerServices.Base.Promise}

Sends an interaction media message

Parameters:
Name Type Description
message string

Message data that is been sent

sensitivity string

Sensitivity of message been sent

Returns:
{ AvayaCustomerServices.Base.Promise }

sendCoBrowseSessionKey(key) → {AvayaCustomerServices.Base.Promise}

Sends a CoBrowse session key

Parameters:
Name Type Description
key string

CoBrowse session key to send

Returns:
{ AvayaCustomerServices.Base.Promise }

sendEmail(data) → {AvayaCustomerServices.Base.Promise}

Sends an interaction media email message

Parameters:
Name Type Description
data Object

Email data

Properties
Name Type Argument Description
subject string

Subject of email

message string

Content of Email

to Array.<string>

Email address to send message to

from string

Email address

cc Array.<string> <optional>

Optional list of cc recipients

bcc Array.<string> <optional>

Optional list of bcc recipients

type string <optional>

Type of the email

Returns:
{ AvayaCustomerServices.Base.Promise }

sendPagePushUrl(message, sensitivity) → {AvayaCustomerServices.Base.Promise}

Sends an interaction media page push URL

Parameters:
Name Type Description
message string

Page push URL data to send

sensitivity string

Sensitivity of message been sent

Returns:
{ AvayaCustomerServices.Base.Promise }

sendRichMedia(media, richMediaType, additionalRichMediaData) → {AvayaCustomerServices.Base.Promise}

Sends an interaction rich media message

Parameters:
Name Type Description
media string

Media data that is been sent

richMediaType string

Type of rich-media

additionalRichMediaData object

Additional fields for rich-media messages

Returns:
{ AvayaCustomerServices.Base.Promise }

Type Definitions

onAttachmentAddedCallback(message)

This callback handles the InteractionMediaAttachmentsEvent response

Parameters:
Name Type Description
message InteractionMediaAttachmentsEvent

The event that is fired when interaction media attachment has been added

onAttachmentRemovedCallback(message)

This callback handles the InteractionMediaAttachmentEvent response

Parameters:
Name Type Description
message InteractionMediaAttachmentsEvent

The event that is fired when interaction media attachment has been removed

onConnectedCallback(message)

This callback handles the InteractionMediaConnectedEvent response

Parameters:
Name Type Description
message InteractionMediaConnectedEvent

The event that is fired when interaction media has been (re)connected

onCustomerDownloadCompleteCallback(message)

This callback handles the InteractionMediaCustomerDownloadCompleteEvent response

Parameters:
Name Type Description
message InteractionMediaCustomerDownloadCompleteEvent

The event that is fired when a a customer completes a file transfer (download)

onCustomerDownloadInitiatedCallback(message)

This callback handles the InteractionMediaCustomerDownloadInitiatedEvent response

Parameters:
Name Type Description
message InteractionMediaCustomerDownloadInitiatedEvent

The event that is fired when a a customer initiates a file transfer (download)

onDisconnectedCallback(message)

This callback handles the InteractionMediaDisconnectedEvent response

Parameters:
Name Type Description
message InteractionMediaDisconnectedEvent

The event that is fired when interaction media has been disconnected

onEmailFileLimitExceededCallback(message)

This callback handles the InteractionMediaEmailFileLimitExceededEvent response

Parameters:
Name Type Description
message InteractionMediaEmailFileLimitExceededEvent

The event that is fired when email's size limit has been exceeded

onFileTransferredCallback(message)

This callback handles the InteractionMediaTransferredFileEvent response

Parameters:
Name Type Description
message InteractionMediaTransferredFileEvent

The event that is fired when a file has been uploaded for transfer

onForwardSentCallback(message)

This callback handles the InteractionMediaEmailForwardSentEvent response

Parameters:
Name Type Description
message InteractionMediaEmailForwardSentEvent

The event that is fired when forward email has been sent

onIsTypingCallback(message)

This callback handles the InteractionMediaMessageIsTypingEvent response

Parameters:
Name Type Description
message InteractionMediaMessageIsTypingEvent

The event that is fired when participant begins to type a new message

onMessageReceivedCallback(message)

This callback handles the InteractionMediaMessageCreatedEvent response

Parameters:
Name Type Description
message InteractionMediaMessageCreatedEvent

The event that is fired when interaction media message has been created

onMessagesReceivedCallback(message)

This callback handles the InteractionMediaMessagesCreatedEvent response

Parameters:
Name Type Description
message InteractionMediaMessagesCreatedEvent

The event that is fired when interaction media messages has been created

onPagePushUrlCallback(message)

This callback handles the InteractionMediaPagePushUrlEvent response

Parameters:
Name Type Description
message InteractionMediaPagePushUrlEvent

The event that is fired when interaction media page push URL has been created

onParticipantAddedCallback(message)

This callback handles the InteractionMediaParticipantJoinedEvent response

Parameters:
Name Type Description
message InteractionMediaParticipantJoinedEvent

The event that is fired when participant has joined interaction media

onParticipantRemovedCallback(message)

This callback handles the InteractionMediaParticipantLeftEvent response

Parameters:
Name Type Description
message InteractionMediaParticipantLeftEvent

The event that is fired when participant has left interaction media

onParticipantsListedCallback(message)

This callback handles the InteractionMediaParticipantsListedEvent response

Parameters:
Name Type Description
message InteractionMediaParticipantJoinedEvent

The event that is fired when participants are retrieved from server

©2019 Avaya Inc. All Rights Reserved.