Avaya Client Services API Reference (OS X)

- Main Page
- Classes
- Files
- Related Pages

- File List
- File Members

Enumerations
CSMessagingEnums.h File Reference
`#import <Foundation/Foundation.h>`

## Enumerations
enum | CSMessagingRefreshMode { CSMessagingRefreshModePush = 0, CSMessagingRefreshMode1Minute = 1, CSMessagingRefreshMode2Minutes = 2, CSMessagingRefreshMode5Minutes = 5, CSMessagingRefreshMode10Minutes = 10, CSMessagingRefreshMode15Minutes = 15, CSMessagingRefreshMode30Minutes = 30, CSMessagingRefreshMode60Minutes = 60, CSMessagingRefreshModeManual = 1000 }
| Enumeration representing messaging polling refresh modes. More...
enum | CSMessagingProviderType { CSMessagingProviderTypeAvayaMultimediaMessaging, CSMessagingProviderTypeAvayaEquinoxCloud, CSMessagingProviderTypeAvayaOneXPortal }
| Enumeration representing messaging sources. More...
enum | CSMessagingType { CSMessagingTypeMessage, CSMessagingTypeJoined, CSMessagingTypeLeft, CSMessagingTypeSession, CSMessagingTypeSubjectChanged, CSMessagingTypeClosed, CSMessagingTypeStart }
| Describes the possible types of messages that can be included in a conversation. More...
enum | CSMessagingReasonType { CSMessagingReasonTypeNone = 0, CSMessagingReasonTypeManual, CSMessagingReasonTypeAuto, CSMessagingReasonTypeForced }
| Provides additional reason information for the Left and Closed message types. More...
enum | CSMessagingImportance { CSMessagingImportanceNormal = 0, CSMessagingImportanceLow, CSMessagingImportanceHigh }
| Provides additional reason information for the Left and Closed message types. More...
enum | CSMessagingSensitivityLevel { CSMessagingSensitivityLevelNormal = 0, CSMessagingSensitivityLevelPersonal, CSMessagingSensitivityLevelPrivate, CSMessagingSensitivityLevelConfidential }
| Represents the sensitivity of the conversation. More...
enum | CSMessagingParticipantType { CSMessagingParticipantTypeUndefined = 0, CSMessagingParticipantTypeContact, CSMessagingParticipantTypeExternal, CSMessagingParticipantTypeTopic, CSMessagingParticipantTypeTeam, CSMessagingParticipantTypeDistributionList, CSMessagingParticipantTypeSysAdmin }
| Represents the participant type. More...
enum | CSMessagingParticipantSourceType { CSMessagingParticipantSourceTypeEnterprise, CSMessagingParticipantSourceTypeCloud, CSMessagingParticipantSourceTypeUndefined }
| Represents the messaging source that the participant comes from. More...
enum | CSMessagingParticipantPhoneNumberType { CSMessagingParticipantPhoneNumberTypeUndefined, CSMessagingParticipantPhoneNumberTypeWork, CSMessagingParticipantPhoneNumberTypeHome, CSMessagingParticipantPhoneNumberTypeMobile, CSMessagingParticipantPhoneNumberTypePager, CSMessagingParticipantPhoneNumberTypeFax, CSMessagingParticipantPhoneNumberTypeCustom }
| Represents type of phone number. More...
enum | CSMessagingDisplayOrder { CSMessagingDisplayOrderFirst, CSMessagingDisplayOrderLast }
| Messaging display order. More...
enum | CSMessagingSortOrder { CSMessagingSortOrderFirst, CSMessagingSortOrderLast }
| Messaging sort order. More...
enum | CSMessagingConversationType { CSMessagingConversationTypeTopic, CSMessagingConversationTypeThread, CSMessagingConversationTypeP2P }
| Represents the conversation type. More...
enum | CSMessagingParticipantModality { CSMessagingParticipantModalityUndefined = 0, CSMessagingParticipantModalityText, CSMessagingParticipantModalityAudio, CSMessagingParticipantModalityVideo, CSMessagingParticipantModalityImage, CSMessagingParticipantModalityGenericAttachment }
| Messaging participant modality. More...
enum | CSMessagingAttachmentStatus { CSMessagingAttachmentStatusDraft, CSMessagingAttachmentStatusSending, CSMessagingAttachmentStatusReadyToDownload, CSMessagingAttachmentStatusDownloading, CSMessagingAttachmentStatusReadyToOpen, CSMessagingAttachmentStatusOpened, CSMessagingAttachmentStatusDraftError, CSMessagingAttachmentStatusDraftRemoving }
| Represents the message attachment status. More...
enum | CSMessagingConversationStatus { CSMessagingConversationStatusUnsent, CSMessagingConversationStatusSending, CSMessagingConversationStatusRemoving, CSMessagingConversationStatusError, CSMessagingConversationStatusSent, CSMessagingConversationStatusLeaving, CSMessagingConversationStatusLeft }
| Represents the server reconciled status of the conversation. More...
enum | CSMessagingMessageStatus { CSMessagingMessageStatusUnsent, CSMessagingMessageStatusSending, CSMessagingMessageStatusRemoving, CSMessagingMessageStatusError, CSMessagingMessageStatusSent }
| Message status. More...
enum | CSMessagingSessionType { CSMessagingSessionTypeUndefined = 0, CSMessagingSessionTypeAudio, CSMessagingSessionTypeVideo }
| Messaging session type. More...
enum | CSMessagingMessageReadState { CSMessagingMessageReadStateUnknown, CSMessagingMessageReadStateNotRead, CSMessagingMessageReadStateRead, CSMessagingMessageReadStatePartiallyRead }
| Represents read state of a message. More...
enum | CSMessagingMessageDeliveryState { CSMessagingMessageDeliveryStateUnsent, CSMessagingMessageDeliveryStateSent, CSMessagingMessageDeliveryStateDelivered }
| Represents delivery state of a message. More...

## Enumeration Type Documentation

enum CSMessagingAttachmentStatus

Represents the message attachment status.

Enumerator
CSMessagingAttachmentStatusDraft | The attachment hasn't been sent yet.
CSMessagingAttachmentStatusSending | The attachment is currently being sent.
CSMessagingAttachmentStatusReadyToDownload | Attachment is ready to be downloaded.
CSMessagingAttachmentStatusDownloading | Attachment is being downloaded.
CSMessagingAttachmentStatusReadyToOpen | Attachment is ready to consume.
CSMessagingAttachmentStatusOpened | Attachment was already opened by user.
CSMessagingAttachmentStatusDraftError | Failed to send the attachment. The messaging limits for attachments may have been exceeded.
CSMessagingAttachmentStatusDraftRemoving | Attachment is being removed from the message.

enum CSMessagingConversationStatus

Represents the server reconciled status of the conversation.

Enumerator
CSMessagingConversationStatusUnsent | Represents a conversation that has been created by the local application but has not yet been sent.
CSMessagingConversationStatusSending | Used for conversations which are currently being sent.
CSMessagingConversationStatusRemoving | Used for conversations which are currently being removed.
CSMessagingConversationStatusError | State indicating that conversation couldn't be sent. Additional error information is provided within the operation result.
CSMessagingConversationStatusSent | A conversation in Published state has been successfully sent to the server and is now able to be viewed by other participants.
CSMessagingConversationStatusLeaving | Used for conversations which are currently being left.
CSMessagingConversationStatusLeft | Used for conversations which were left.

enum CSMessagingConversationType

Represents the conversation type.

Enumerator
CSMessagingConversationTypeTopic | A published conversation to which any user may subscribe. Topics are based on a social-networking interaction model. Users elect to subscribe to a conversation of interest to them, and can join, leave, and rejoin at their discretion. All content of a topic is available to all who observe it, very much like an internet forum or message board. This conversation type is not currenlty supported.
CSMessagingConversationTypeThread | A private conversation between participants. The participants in a thread must each be invited to the conversation (either at the outset, or over the course of the conversation). Participants can elect to leave a thread, but cannot rejoin unless re-invited by an active participant. The content of a thread is not the same for all participants; it is directly related to when a user has joined and left the conversation. You are only aware of conversation activity that occurs while you are an active participant.
CSMessagingConversationTypeP2P | A peer to peer conversation. Adding and removing additional participants is not allowed. Participants cannot leave thread.

enum CSMessagingDisplayOrder

Messaging display order.

Enumerator
CSMessagingDisplayOrderFirst |
CSMessagingDisplayOrderLast |

enum CSMessagingImportance

Provides additional reason information for the Left and Closed message types.

Enumerator
CSMessagingImportanceNormal | The message reason is not specified.
CSMessagingImportanceLow | The message is a result of a manual intervention.
CSMessagingImportanceHigh | The message is generated by the system.

enum CSMessagingMessageDeliveryState

Represents delivery state of a message.

Enumerator
CSMessagingMessageDeliveryStateUnsent | Default value for draft outgoing message.
CSMessagingMessageDeliveryStateSent | Delivered to messaging server (outgoing message sent successfully).
CSMessagingMessageDeliveryStateDelivered | Delivered to one or more recipients (both incoming and outgoing messages).

enum CSMessagingMessageReadState

Represents read state of a message.

Enumerator
CSMessagingMessageReadStateUnknown | Unknown status. Default value for outgoing messages.
CSMessagingMessageReadStateNotRead | Not read by any recipient (outgoing message) or not read by me (incoming messages).
CSMessagingMessageReadStateRead | Read by all recipients (outgoing message) or marked as read by me (incoming message).
CSMessagingMessageReadStatePartiallyRead | Outgoing message read by certain recipients.

enum CSMessagingMessageStatus

Message status.

Enumerator
CSMessagingMessageStatusUnsent | Represents a message that has been created by the local application but has not yet been sent.
CSMessagingMessageStatusSending | Used for messages which are currently being sent.
CSMessagingMessageStatusRemoving | Used for messages which are currently being removed.
CSMessagingMessageStatusError | State indicating that message couldn't be sent. Additional error information is provided within the operation result.
CSMessagingMessageStatusSent | A message in Published state has been successfully sent to the server and is now able to be viewed by other participants in the conversation.

enum CSMessagingParticipantModality

Messaging participant modality.

Enumerator
CSMessagingParticipantModalityUndefined |
CSMessagingParticipantModalityText |
CSMessagingParticipantModalityAudio |
CSMessagingParticipantModalityVideo |
CSMessagingParticipantModalityImage |
CSMessagingParticipantModalityGenericAttachment |

enum CSMessagingParticipantPhoneNumberType

Represents type of phone number.

Enumerator
CSMessagingParticipantPhoneNumberTypeUndefined | Type could not be determined.
CSMessagingParticipantPhoneNumberTypeWork | Work phone number type.
CSMessagingParticipantPhoneNumberTypeHome | Home phone number type.
CSMessagingParticipantPhoneNumberTypeMobile | Mobile phone number type.
CSMessagingParticipantPhoneNumberTypePager | Pager phone number type.
CSMessagingParticipantPhoneNumberTypeFax | Fax phone number type.
CSMessagingParticipantPhoneNumberTypeCustom | Custom phone number type. Actual value can be read from CSMessagingParticipantPhoneNumber.customType.

enum CSMessagingParticipantSourceType

Represents the messaging source that the participant comes from.

Enumerator
CSMessagingParticipantSourceTypeEnterprise | Participant comes from enterprise source.
CSMessagingParticipantSourceTypeCloud | Participant comes from cloud source.
CSMessagingParticipantSourceTypeUndefined | Source type could not be determined.

enum CSMessagingParticipantType

Represents the participant type.

Enumerator
CSMessagingParticipantTypeUndefined | Undefined participant type.
CSMessagingParticipantTypeContact | Contact participant type.
CSMessagingParticipantTypeExternal | External participant type.
CSMessagingParticipantTypeTopic | Topic participant type.
CSMessagingParticipantTypeTeam | Team participant type.
CSMessagingParticipantTypeDistributionList | DistributionList participant type.
CSMessagingParticipantTypeSysAdmin | SystemAdmin participant type.

enum CSMessagingProviderType

Enumeration representing messaging sources.

Enumerator
CSMessagingProviderTypeAvayaMultimediaMessaging | Avaya Multimedia Messaging provider (AMM)
CSMessagingProviderTypeAvayaEquinoxCloud | Avaya Equinox Cloud provider (Zang)
CSMessagingProviderTypeAvayaOneXPortal | Avaya OneX Portal provider.

enum CSMessagingReasonType

Provides additional reason information for the Left and Closed message types.

Enumerator
CSMessagingReasonTypeNone |
CSMessagingReasonTypeManual | The message reason is not specified.
CSMessagingReasonTypeAuto | The message is a result of a manual intervention.
CSMessagingReasonTypeForced | The message is generated by the system. The message is a result of power user's enforcement action. E.g. participant left the conversation due to he was removed by other participant who has appropriate permissions to drop conversation participants.

enum CSMessagingRefreshMode

Enumeration representing messaging polling refresh modes.

Enumerator
CSMessagingRefreshModePush | Push mode means continuous notifications in real time.
CSMessagingRefreshMode1Minute | Polling for changes will be done every one minute.
CSMessagingRefreshMode2Minutes | Polling for changes will be done every two minutes.
CSMessagingRefreshMode5Minutes | Polling for changes will be done every five minutes.
CSMessagingRefreshMode10Minutes | Polling for changes will be done every ten minutes.
CSMessagingRefreshMode15Minutes | Polling for changes will be done every fifteen minutes.
CSMessagingRefreshMode30Minutes | Polling for changes will be done every thirty minutes.
CSMessagingRefreshMode60Minutes | Polling for changes will be done every one hour.
CSMessagingRefreshModeManual | Polling for updates is disabled.

enum CSMessagingSensitivityLevel

Represents the sensitivity of the conversation.

Enumerator
CSMessagingSensitivityLevelNormal | Normal sensitivity level.
CSMessagingSensitivityLevelPersonal | Personal sensitivity level.
CSMessagingSensitivityLevelPrivate | Private sensitivity level.
CSMessagingSensitivityLevelConfidential | Confidential sensitivity level.

enum CSMessagingSessionType

Messaging session type.

Enumerator
CSMessagingSessionTypeUndefined |
CSMessagingSessionTypeAudio |
CSMessagingSessionTypeVideo |

enum CSMessagingSortOrder

Messaging sort order.

Enumerator
CSMessagingSortOrderFirst |
CSMessagingSortOrderLast |

enum CSMessagingType

Describes the possible types of messages that can be included in a conversation.

Enumerator
CSMessagingTypeMessage | Messages of this type contain either body text, attachments, or both. Most messages in a conversation are of this type.
CSMessagingTypeJoined | Joined type is used to notify that new participant has joined the conversation.
CSMessagingTypeLeft | Left type is used to notify that existing participant has left the conversation.
CSMessagingTypeSession | Session type is used to notify that conversation was escalated to audio/video.
CSMessagingTypeSubjectChanged | SubjectChanged type is used to notify that Subject of conversation has changed.
CSMessagingTypeClosed | Closed type is used to notify that the conversation has been closed.
CSMessagingTypeStart | A message of this type is the first message in every conversation. There is no content associated with this message.