Constants
The following constants are available globally.
-
@abstract horizontal image aspect ratio
Declaration
Objective-C
extern NSString *const _Nonnull AVAImageAspectRatioHorizontal
Swift
let AVAImageAspectRatioHorizontal: String
-
@abstract squared image aspect ratio
Declaration
Objective-C
extern NSString *const _Nonnull AVAImageAspectRatioSquare
Swift
let AVAImageAspectRatioSquare: String
-
@abstract Type for a link action.
Declaration
Objective-C
extern NSString *const _Nonnull AVAMessageActionTypeLink
Swift
let AVAMessageActionTypeLink: String
-
@abstract Type for a webview action.
Declaration
Objective-C
extern NSString *const _Nonnull AVAMessageActionTypeWebview
Swift
let AVAMessageActionTypeWebview: String
-
@abstract Type for a buy action.
Declaration
Objective-C
extern NSString *const _Nonnull AVAMessageActionTypeBuy
Swift
let AVAMessageActionTypeBuy: String
-
@abstract Type for a postback action.
Declaration
Objective-C
extern NSString *const _Nonnull AVAMessageActionTypePostback
Swift
let AVAMessageActionTypePostback: String
-
@abstract Type for a reply action
Declaration
Objective-C
extern NSString *const _Nonnull AVAMessageActionTypeReply
Swift
let AVAMessageActionTypeReply: String
-
@abstract Type for a location request
Declaration
Objective-C
extern NSString *const _Nonnull AVAMessageActionTypeLocationRequest
Swift
let AVAMessageActionTypeLocationRequest: String
-
@abstract Offered state for a buy message. The user has not yet completed the transaction.
Declaration
Objective-C
extern NSString *const _Nonnull AVAMessageActionStateOffered
Swift
let AVAMessageActionStateOffered: String
-
@abstract Paid state for a buy message. The user has completed the transaction and payment was successful.
Declaration
Objective-C
extern NSString *const _Nonnull AVAMessageActionStatePaid
Swift
let AVAMessageActionStatePaid: String
-
@abstract A full-sized webview
Declaration
Objective-C
extern NSString *const _Nonnull AVAMessageActionWebviewSizeFull
Swift
let AVAMessageActionWebviewSizeFull: String
-
@abstract A tall-sized webview
Declaration
Objective-C
extern NSString *const _Nonnull AVAMessageActionWebviewSizeTall
Swift
let AVAMessageActionWebviewSizeTall: String
-
@abstract A compact-sized webview
Declaration
Objective-C
extern NSString *const _Nonnull AVAMessageActionWebviewSizeCompact
Swift
let AVAMessageActionWebviewSizeCompact: String
-
Undocumented
Declaration
Objective-C
FOUNDATION_EXPORT double AvMessagingSdkVersionNumber
Swift
var AvMessagingSdkVersionNumber: Double
-
Undocumented
Declaration
Objective-C
FOUNDATION_EXPORT const unsigned char AvMessagingSdkVersionString[]
-
@abstract User info dictionary key to determine the origin of a push notification.
@discussion Push notifications that originate from AvMessagingSdk will have a non-nil value for this key.
BOOL isAvMessagingSdkNotification = userInfo[AVAPushNotificationIdentifier] != nil
Declaration
Objective-C
extern NSString *const _Nonnull AVAPushNotificationIdentifier
Swift
let AVAPushNotificationIdentifier: String
-
@abstract User info dictionary key for an AVAUser after a successful call to +login:jwt:completionHandler:
See
AVAUserSee
AVALoginDidCompleteNotificationSee
+login:jwt:completionHandler:Declaration
Objective-C
extern NSString *const _Nonnull AVAUserIdentifier
Swift
let AVAUserIdentifier: String
-
@abstract User info dictionary key for an AVAConversation after a successful call to +startConversationWithCompletionHandler:
See
AVAConversationSee
+startConversationWithCompletionHandler:Declaration
Objective-C
extern NSString *const _Nonnull AVAConversationIdentifier
Swift
let AVAConversationIdentifier: String
-
@abstract User info dictionary key to determine the error code of a failed operation. Possible operations that may include this value are +initWithSettings:completionHandler:, +login:jwt:completionHandler: and +logoutWithCompletionHandler:
@discussion Possible values include, but are not limited to, “unauthorized”, “invalid_auth”, “bad_request”, “unhandled_error”, “invalid_app” or an empty string for connectivity errors
See
AVAInitializationDidFailNotificationSee
AVALoginDidFailNotificationSee
AVALogoutDidFailNotificationSee
+initWithSettings:completionHandler:See
+login:jwt:completionHandler:See
+logoutWithCompletionHandler:Declaration
Objective-C
extern NSString *const _Nonnull AVAErrorCodeIdentifier
Swift
let AVAErrorCodeIdentifier: String
-
@abstract User info dictionary key to determine the error description of a failed operation. Possible operations that include this value are +initWithSettings:completionHandler:, +login:jwt:completionHandler: and +logoutWithCompletionHandler:
See
AVAInitializationDidFailNotificationSee
AVALoginDidFailNotificationSee
AVALogoutDidFailNotificationSee
+initWithSettings:completionHandler:See
+login:jwt:completionHandler:See
+logoutWithCompletionHandler:Declaration
Objective-C
extern NSString *const _Nonnull AVAErrorDescriptionIdentifier
Swift
let AVAErrorDescriptionIdentifier: String
-
@abstract Custom error domain identifier
Declaration
Objective-C
extern NSString *const _Nonnull AVAErrorDomainIdentifier
Swift
let AVAErrorDomainIdentifier: String
-
@abstract User info dictionary key to determine the HTTP status code of a failed operation. Possible operations that include this value are +initWithSettings:completionHandler:, +login:jwt:completionHandler: and +logoutWithCompletionHandler:
@discussion User info dictionary key to determine the HTTP status code of a failed operation
See
AVAInitializationDidFailNotificationSee
AVALoginDidFailNotificationSee
AVALogoutDidFailNotificationSee
+initWithSettings:completionHandler:See
+login:jwt:completionHandler:See
+logoutWithCompletionHandler:Declaration
Objective-C
extern NSString *const _Nonnull AVAStatusCodeIdentifier
Swift
let AVAStatusCodeIdentifier: String
-
@abstract Identifier for a AvMessagingSdk user notification reply action.
@discussion Used as the identifier for a UIUserNotificationAction on iOS 9, and a UNTextInputNotificationAction on iOS 10 and above.
Declaration
Objective-C
extern NSString *const _Nonnull AVAUserNotificationReplyActionIdentifier
Swift
let AVAUserNotificationReplyActionIdentifier: String
-
@abstract Identifier for a AvMessagingSdk user notification category.
@discussion Used as the identifier for a UIUserNotificationCategory on iOS 9, and a UNNotificationCategory on iOS 10 and above.
Declaration
Objective-C
extern NSString *const _Nonnull AVAUserNotificationReplyCategoryIdentifier
Swift
let AVAUserNotificationReplyCategoryIdentifier: String
-
@abstract Notification that fires when initialization completes successfully
@discussion This notification is fired each time a call to +initWithSettings:completionHandler: completes with a non-error status code.
See
+initWithSettings:completionHandler:Declaration
Objective-C
extern NSString *const _Nonnull AVAInitializationDidCompleteNotification
Swift
static let AVAInitializationDidComplete: NSNotification.Name
-
@abstract Notification that fires when initialization fails
@discussion This notification is fired each time a call to +initWithSettings:completionHandler: fails.
You may use this notification to know if initialization failed due to an invalid app ID, invalid JWT, or connectivity errors by inspecting the
userInfo
dictionary included with it.See
AVAErrorCodeIdentifierSee
AVAErrorDescriptionIdentifierSee
AVAStatusCodeIdentifierDeclaration
Objective-C
extern NSString *const _Nonnull AVAInitializationDidFailNotification
Swift
static let AVAInitializationDidFail: NSNotification.Name
-
@abstract Notification that fires when +login:jwt:completionHandler: completes successfully
@discussion This notification is fired each time a call to +login:jwt:completionHandler: completes with a non-error status code.
See
+login:jwt:completionHandler:See
AVAUserIdentifierDeclaration
Objective-C
extern NSString *const _Nonnull AVALoginDidCompleteNotification
Swift
static let AVALoginDidComplete: NSNotification.Name
-
@abstract Notification that fires when +login:jwt:completionHandler: fails
@discussion This notification is fired each time a call to +login:jwt:completionHandler: fails.
You may use this notification to know if a call to +login:jwt:completionHandler: failed due to an invalid JWT, or connectivity errors by inspecting the
userInfo
dictionary included with it.See
AVAErrorCodeIdentifierSee
AVAErrorDescriptionIdentifierSee
AVAStatusCodeIdentifierDeclaration
Objective-C
extern NSString *const _Nonnull AVALoginDidFailNotification
Swift
static let AVALoginDidFail: NSNotification.Name
-
@abstract Notification that fires when +logoutWithCompletionHandler: completes successfully
@discussion This notification is fired each time a call to +logoutWithCompletionHandler: completes with a non-error status code.
See
+logoutWithCompletionHandler:Declaration
Objective-C
extern NSString *const _Nonnull AVALogoutDidCompleteNotification
Swift
static let AVALogoutDidComplete: NSNotification.Name
-
@abstract Notification that fires when a call to +logoutWithCompletionHandler: fails
@discussion This notification is fired when a call to +logoutWithCompletionHandler: fails
See
AVAErrorCodeIdentifierSee
AVAErrorDescriptionIdentifierSee
AVAStatusCodeIdentifierDeclaration
Objective-C
extern NSString *const _Nonnull AVALogoutDidFailNotification
Swift
static let AVALogoutDidFail: NSNotification.Name
-
@abstract Posted when the count of unread messages changes. The notification object will be an instance of AVAConversation, of which you can then inspect the messageCount property.
See
AVAConversationDeclaration
Objective-C
extern NSString *const _Nonnull AVAConversationUnreadCountDidChangeNotification
Swift
static let AVAConversationUnreadCountDidChange: NSNotification.Name
-
@abstract Posted when an image upload begins.
@discussion The userInfo dictionary contains the UIImage to upload. Use AVAConversationImageKey to access this value.
This notification is guaranteed to fire on the main thread.
See
AVAConversationImageKeyDeclaration
Objective-C
extern NSString *const _Nonnull AVAConversationImageUploadDidStartNotification
Swift
static let AVAConversationImageUploadDidStart: NSNotification.Name
-
@abstract Posted when an image upload receives a progress update.
@discussion The userInfo dictionary contains the UIImage being uploaded, as well as an NSNumber reflecting the current progress. Use AVAConversationImageKey and AVAConversationProgressKey to access these values.
This notification is guaranteed to fire on the main thread.
See
AVAConversationImageKeySee
AVAConversationProgressKeyDeclaration
Objective-C
extern NSString *const _Nonnull AVAConversationImageUploadProgressDidChangeNotification
Swift
static let AVAConversationImageUploadProgressDidChange: NSNotification.Name
-
@abstract Posted when an image upload completes, either in success or failure.
@discussion The userInfo dictionary contains the UIImage that was uploaded. Use AVAConversationImageKey to access this value.
If the upload succeeded, the userInfo dictionary will also include the AVAMessage instance of the new message. Use AVAConversationMessageKey to access this value. If the upload failed, the userInfo dictionary will include the NSError that occurred. Use AVAConversationErrorKey to access this value.
This notification is guaranteed to fire on the main thread.
See
AVAMessageSee
AVAConversationImageKeySee
AVAConversationMessageKeySee
AVAConversationErrorKeyDeclaration
Objective-C
extern NSString *const _Nonnull AVAConversationImageUploadCompletedNotification
Swift
static let AVAConversationImageUploadCompleted: NSNotification.Name
-
@abstract Posted when a file upload begins.
@discussion The userInfo dictionary contains the url of the file to upload. Use AVAConversationFileKey to access this value.
This notification is guaranteed to fire on the main thread.
See
AVAConversationFileKeyDeclaration
Objective-C
extern NSString *const _Nonnull AVAConversationFileUploadDidStartNotification
Swift
static let AVAConversationFileUploadDidStart: NSNotification.Name
-
@abstract Posted when a file upload receives a progress update.
@discussion The userInfo dictionary contains the url of the file being uploaded, as well as an NSNumber reflecting the current progress. Use AVAConversationFileKey and AVAConversationProgressKey to access these values.
This notification is guaranteed to fire on the main thread.
See
AVAConversationFileKeySee
AVAConversationProgressKeyDeclaration
Objective-C
extern NSString *const _Nonnull AVAConversationFileUploadProgressDidChangeNotification
Swift
static let AVAConversationFileUploadProgressDidChange: NSNotification.Name
-
@abstract Posted when a file upload completes, either in success or failure.
@discussion The userInfo dictionary contains the url of the file that was uploaded. Use AVAConversationFileKey to access this value.
If the upload succeeded, the userInfo dictionary will also include the AVAMessage instance of the new message. Use AVAConversationMessageKey to access this value. If the upload failed, the userInfo dictionary will include the NSError that occurred. Use AVAConversationErrorKey to access this value.
This notification is guaranteed to fire on the main thread.
See
AVAMessageSee
AVAConversationFileKeySee
AVAConversationMessageKeySee
AVAConversationErrorKeyDeclaration
Objective-C
extern NSString *const _Nonnull AVAConversationFileUploadCompletedNotification
Swift
static let AVAConversationFileUploadCompleted: NSNotification.Name
-
@abstract Posted when new messages are received from the server.
@discussion The userInfo dictionary contains an NSArray of AVAMessage objects. Use AVAConversationNewMessagesKey to access this value.
See
AVAMessageSee
AVAConversationNewMessagesKeyDeclaration
Objective-C
extern NSString *const _Nonnull AVAConversationDidReceiveMessagesNotification
Swift
static let AVAConversationDidReceiveMessages: NSNotification.Name
-
@abstract Posted when an operation to load previous messages in a conversation has been completed
@discussion This notification is posted as the result of [AVAConversation loadPreviousMessages]
If the operation succeeded, the object returned by this notification will include the updated array of messages If the operation failed, the userInfo dictionary will contain an “error” object with the response error
See
AVAMessageSee
AVAConversationPreviousMessagesKeyDeclaration
Objective-C
extern NSString *const _Nonnull AVAConversationDidReceivePreviousMessagesNotification
Swift
static let AVAConversationDidReceivePreviousMessages: NSNotification.Name
-
@abstract Posted when a conversation activity has been created, such as typing start/stop
See
AVAConversationActivitySee
AVAConversationActivityKeyDeclaration
Objective-C
extern NSString *const _Nonnull AVAConversationDidReceiveActivityNotification
Swift
static let AVAConversationDidReceiveActivity: NSNotification.Name
-
@abstract A key whose value is an NSArray of AVAMessage objects.
@discussion This key is used with AVAConversationDidReceiveMessagesNotification notification.
See
AVAConversationDidReceiveMessagesNotificationDeclaration
Objective-C
extern NSString *const _Nonnull AVAConversationNewMessagesKey
Swift
let AVAConversationNewMessagesKey: String
-
@abstract A key whose value is an NSArray of AVAMessage objects
@discussion This key is used with AVAConversationDidReceivePreviousMessagesNotification notification
See
AVAConversationDidReceivePreviousMessagesNotificationDeclaration
Objective-C
extern NSString *const _Nonnull AVAConversationPreviousMessagesKey
Swift
let AVAConversationPreviousMessagesKey: String
-
@abstract A key whose value is a UIImage which represents an image being uploaded.
@discussion This key is used with AVAConversationImageUploadDidStartNotification, AVAConversationImageUploadProgressDidChangeNotification, and AVAConversationImageUploadCompletedNotification notifications.
See
AVAConversationImageUploadDidStartNotificationSee
AVAConversationImageUploadProgressDidChangeNotificationSee
AVAConversationImageUploadCompletedNotificationDeclaration
Objective-C
extern NSString *const _Nonnull AVAConversationImageKey
Swift
let AVAConversationImageKey: String
-
@abstract A key whose value is an NSURL which represents a file being uploaded.
@discussion This key is used with AVAConversationFileUploadDidStartNotification, AVAConversationFileUploadProgressDidChangeNotification, and AVAConversationFileUploadCompletedNotification notifications.
See
AVAConversationFileUploadDidStartNotificationSee
AVAConversationFileUploadProgressDidChangeNotificationSee
AVAConversationFileUploadCompletedNotificationDeclaration
Objective-C
extern NSString *const _Nonnull AVAConversationFileKey
Swift
let AVAConversationFileKey: String
-
@abstract A key whose value is an NSError.
@discussion This key is used with AVAConversationImageUploadCompletedNotification notification.
See
AVAConversationImageUploadCompletedNotificationDeclaration
Objective-C
extern NSString *const _Nonnull AVAConversationErrorKey
Swift
let AVAConversationErrorKey: String
-
@abstract A key whose value is an AVAMessage object representing the newly created message.
@discussion This key is used with AVAConversationImageUploadCompletedNotification notification.
See
AVAConversationImageUploadCompletedNotificationDeclaration
Objective-C
extern NSString *const _Nonnull AVAConversationMessageKey
Swift
let AVAConversationMessageKey: String
-
@abstract A key whose value is an NSNumber reflecting the current progress of an image upload.
@discussion This key is used with AVAConversationImageUploadProgressDidChangeNotification notification.
See
AVAConversationImageUploadProgressDidChangeNotificationDeclaration
Objective-C
extern NSString *const _Nonnull AVAConversationProgressKey
Swift
let AVAConversationProgressKey: String
-
@abstract A key whose value is a AVAConversationActivity object representing the newly created activity
@discussion This key is used with AVAConversationDidReceiveActivityNotification notification.
See
AVAConversationDidReceiveActivityNotificationDeclaration
Objective-C
extern NSString *const _Nonnull AVAConversationActivityKey
Swift
let AVAConversationActivityKey: String
-
@abstract An activity type indicating that a participant of the converation started typing a response
Declaration
Objective-C
extern NSString *const _Nonnull AVAConversationActivityTypeTypingStart
Swift
let AVAConversationActivityTypeTypingStart: String
-
@abstract An activity type indicating that a participant of the converation stopped typing a response
Declaration
Objective-C
extern NSString *const _Nonnull AVAConversationActivityTypeTypingStop
Swift
let AVAConversationActivityTypeTypingStop: String
-
@abstract An activity type indicating that a participant of the converation recently read the user message
This event type is triggered for the current user when the conversation is read on a different device.
Declaration
Objective-C
extern NSString *const _Nonnull AVAConversationActivityTypeConversationRead
Swift
let AVAConversationActivityTypeConversationRead: String
-
@abstract An activity type indicating that the current user was added to a conversation
Declaration
Objective-C
extern NSString *const _Nonnull AVAConversationActivityTypeConversationAdded
Swift
let AVAConversationActivityTypeConversationAdded: String
-
@abstract An activity type indicating that the current user was removed from a conversation
Declaration
Objective-C
extern NSString *const _Nonnull AVAConversationActivityTypeConversationRemoved
Swift
let AVAConversationActivityTypeConversationRemoved: String
-
@abstract An activity type indicating that another user was added to a conversation that the current user is part of
Declaration
Objective-C
extern NSString *const _Nonnull AVAConversationActivityTypeParticipantAdded
Swift
let AVAConversationActivityTypeParticipantAdded: String
-
@abstract An activity type indicating that another user was removed from a conversation that the current user is part of
Declaration
Objective-C
extern NSString *const _Nonnull AVAConversationActivityTypeParticipantRemoved
Swift
let AVAConversationActivityTypeParticipantRemoved: String
-
@abstract A key whose value is an NSString representing the business name.
@discussion This key is used in the AVAConversationActivity data object.
Declaration
Objective-C
extern NSString *const _Nonnull AVAConversationActivityDataNameKey
Swift
let AVAConversationActivityDataNameKey: String
-
@abstract A key whose value is an NSString representing the URL of the business avatar.
@discussion This key is used in the AVAConversationActivity data object.
Declaration
Objective-C
extern NSString *const _Nonnull AVAConversationActivityDataAvatarUrlKey
Swift
let AVAConversationActivityDataAvatarUrlKey: String
-
@abstract Notification that is fired when a message fails to upload.
Declaration
Objective-C
extern NSString *const _Nonnull AVAMessageUploadFailedNotification
Swift
static let AVAMessageUploadFailed: NSNotification.Name
-
@abstract Notification that is fired when a message uploads successfully.
Declaration
Objective-C
extern NSString *const _Nonnull AVAMessageUploadCompletedNotification
Swift
static let AVAMessageUploadCompleted: NSNotification.Name
-
@abstract A type of message that contains an image, text, and/or action buttons
Declaration
Objective-C
extern NSString *const _Nonnull AVAMessageTypeImage
Swift
let AVAMessageTypeImage: String
-
@abstract A type of message that contains text and/or action buttons
Declaration
Objective-C
extern NSString *const _Nonnull AVAMessageTypeText
Swift
let AVAMessageTypeText: String
-
@abstract A type of message that contains a location
Declaration
Objective-C
extern NSString *const _Nonnull AVAMessageTypeLocation
Swift
let AVAMessageTypeLocation: String
-
@abstract A type of message that contains a file and/or text
Declaration
Objective-C
extern NSString *const _Nonnull AVAMessageTypeFile
Swift
let AVAMessageTypeFile: String
-
@abstract A type of message that contains a horizontally scrollable set of items
Declaration
Objective-C
extern NSString *const _Nonnull AVAMessageTypeCarousel
Swift
let AVAMessageTypeCarousel: String
-
@abstract A type of message that contains a vertically scrollable set of items
Declaration
Objective-C
extern NSString *const _Nonnull AVAMessageTypeList
Swift
let AVAMessageTypeList: String
-
@abstract When added to allowedMenuItems, enables the option to take a photo from the conversation view
Declaration
Objective-C
extern NSString *const _Nonnull AVAMenuItemCamera
Swift
let AVAMenuItemCamera: String
-
@abstract When added to allowedMenuItems, enables the option to select an image or video from gallery from the conversation view
Declaration
Objective-C
extern NSString *const _Nonnull AVAMenuItemGallery
Swift
let AVAMenuItemGallery: String
-
@abstract When added to allowedMenuItems, enables the option to upload a document from the conversation view
Declaration
Objective-C
extern NSString *const _Nonnull AVAMenuItemDocument
Swift
let AVAMenuItemDocument: String
-
@abstract When added to allowedMenuItems, enables the option to share location from the conversation view
Declaration
Objective-C
extern NSString *const _Nonnull AVAMenuItemLocation
Swift
let AVAMenuItemLocation: String