STWMessaging Manager

confirmAckMessageReception

~~open~~ ~~fun~~ ~~closeConversation~~( @NonNull context: Context, @NonNull conversationId: String, @Nullable callback: STWOperationCallback<MessagingError>)

Call this method to close an existing group conversation.

open fun confirmAckMessageReception( @NonNull context: Context, @NonNull messageId: String, @Nullable callback: STWOperationCallback<MessagingError>)

Call this method to confirm the reception of an acknowledged message.

createConversation

open fun createConversation( @NonNull recipients: Array<String>, conversationType: Int, @NonNull conversationName: String, isAvailableOnlyRecipients: Boolean, @Nullable completion: CreateConversationCallback)

Call this method to create a new conversation, The created conversation will be empty.

createNewConversation

open fun createNewConversation(@NonNull context: Context, @NonNull thread: ThreadItem)

Call this method to create a new conversation in the local Database.

deleteConversation

~~open~~ ~~fun~~ ~~deleteConversation~~( @NonNull context: Context, @NonNull conversation: ThreadItem, @Nullable callback: STWOperationCallback<MessagingError>)

Call this method to delete an existing conversation.

deleteConversations

enableMessageReadConfirmation

~~open~~ ~~fun~~ ~~deleteConversations~~( @NonNull context: Context, @NonNull conversations: List<ThreadItem>, @Nullable callback: STWOperationCallback<MessagingError>)

Call this method to delete an existing list of conversations.

deleteMessage

open fun deleteMessage( @NonNull context: Context, @NonNull messageId: String, @Nullable callback: STWOperationCallback<MessagingError>)

Call this method to delete an existing message from local Database and server.

open fun deleteMessage( @NonNull context: Context, @NonNull messageList: List<BaseMessage>, @Nullable callback: STWOperationCallback<MessagingError>)

Call this method to delete an existing list of messages.

open fun enableMessageReadConfirmation( @NonNull context: Context, isEnabled: Boolean, @Nullable callBack: STWOperationCallback<MessagingError>)

Call this method to change the read confirmation feature.

enableMessagesAutoDeletionTask

getAdminInitiatorOfConversation

~~open~~ ~~fun~~ ~~enableMessagesAutoDeletionTask~~()

Call this method to permanently delete messages from the local database after a defined period of time in milli seconds.

forwardMessages

open fun forwardMessages( @NonNull context: Context, @NonNull conversationId: String, @NonNull messageIdList: List<String>, @Nullable completion: CompletionCallback)

Call this method to forward messages to another existing conversation.

open fun forwardMessages( @NonNull context: Context, @NonNull messageIdList: List<String>, @NonNull recipients: Array<String>, conversationType: Int, @Nullable conversationName: String, @Nullable completion: CompletionCallback)

Call this method to forward messages to anther users and/or groups.

open fun getAdminInitiatorOfConversation(@NonNull context: Context, @NonNull conversationId: String): PhoneItem

Call this method to retrieve admin initiator in a group conversation

getAllConversations

open fun getAllConversations(@NonNull context: Context): List<ThreadItem>

open fun getAllConversations( @NonNull context: Context, @IntRange(from = 0) startingFrom: Int, @IntRange(from = 1) numberOfConversation: Int): List<ThreadItem>

Call this method to retrieve all conversations from local Database.

getAllMessagesByType

getCompanyConversationByRecipientNumber

open fun getAllMessagesByType( @NonNull context: Context, @NonNull messageType: List<String>, @NonNull sessionTypes: List<Integer>, @IntRange(from = 0) startingFrom: Int, @IntRange(from = 1) numberOfMessage: Int): List<BaseMessage>

Call this method to retrieve all messages from local Database by message type.

open fun getCompanyConversationByRecipientNumber(@NonNull context: Context, @NonNull internationalNumber: String): ThreadItem

Call this method to retrieve the company conversation from local Database initiated with the given user (internationalNumber).

getCompanyConversations

open fun getCompanyConversations(@NonNull context: Context): List<ThreadItem>

open fun getCompanyConversations( @NonNull context: Context, @IntRange(from = 0) startingFrom: Int, @IntRange(from = 1) numberOfConversation: Int): List<ThreadItem>

Call this method to retrieve all company conversations from local Database.

getConversationByGroupId

open fun getConversationByGroupId(@NonNull context: Context, @NonNull groupId: String): ThreadItem

Call this method to retrieve the conversation (group as type) represented by ThreadItem object given a groupId.

getConversationById

getConversationByRecipient

open fun getConversationById(@NonNull context: Context, @NonNull conversationId: String): ThreadItem

Call this method to retrieve the conversation represented by ThreadItem object given a conversationId.

getConversationByRecipientNumber

open fun getConversationByRecipient(@NonNull context: Context, @NonNull internationalNumber: String): ThreadItem

Call this method to retrieve a one to one conversation from local Database object given international phone number of the recipient.

getConversationListContainingRecipientGroupId

open fun getConversationByRecipientNumber(@NonNull context: Context, @NonNull internationalNumber: String): ThreadItem

Call this method to retrieve the conversation from local Database initiated with the given user (internationalNumber).

getConversationListForRecipientGroupId

open fun getConversationListContainingRecipientGroupId(@NonNull context: Context, @NonNull groupId: String): List<ThreadItem>

Call this method to retrieve all related conversations for a given groupId.

getDeletableConversationCount

open fun getConversationListForRecipientGroupId(@NonNull context: Context, @NonNull groupId: String): List<ThreadItem>

Call this method to retrieve all related conversations for a given groupId.

open fun getDeletableConversationCount(@NonNull context: Context): Int

Call this method to get the number of conversations that can be deleted.

getDeliveryFallBackMessageDelay

open fun getDeliveryFallBackMessageDelay(@NonNull context: Context): Int

Call This method to get the fallBack message delay for delivery timer "DeliveryTimer" during which we wait for a delivery report from the server.

getDeliveryReportForIncomingMessage

getDeliveryReportListByMessageId

open fun getDeliveryReportForIncomingMessage(@NonNull context: Context, @NonNull messageId: String): MessageDeliveryReport

Call this method to retrieve the message delivery report received for a given message id from local Database.

getDraftMessageByConversationId

open fun getDeliveryReportListByMessageId(@NonNull context: Context, @NonNull messageId: String): List<MessageDeliveryReport>

Call this method to retrieve all message delivery list given a message id from local Database.

open fun getDraftMessageByConversationId(@NonNull context: Context, @NonNull conversationId: String): BaseMessage

Call this method to retrieve the draft message given conversationId from local Database represented by BaseMessage object.

getExternalConversations

getGroupConversationByRecipients

open fun getExternalConversations(@NonNull context: Context): List<ThreadItem>

Call this method to retrieve all external conversations from local Database.

open fun getGroupConversationByRecipients(@NonNull context: Context, @NonNull recipients: Array<String>): ThreadItem

Call this method to retrieve a group conversation from local Database object given groups and users.

getGroupsInConversation

getLastActiveConversationByGroupId

open fun getGroupsInConversation(@NonNull context: Context, @Nullable conversationId: String): List<ContactItem>

Call this method to retrieve recipient groups in the given conversation.

getInstance

@NonNull

open fun getInstance(): STWMessagingManager

getLastEmergencyMessageId

open fun getLastActiveConversationByGroupId(@NonNull context: Context, @NonNull groupId: String): ThreadItem

Call this method to retrieve the last active conversation (one to many or group) from local Database initiated with only the given group ID.

getLastMessageContainsLocationPins

open fun getLastEmergencyMessageId(@NonNull context: Context, @NonNull conversationId: String): String

Call this method to retrieve the last emergency message id from local dataBase This emergency message can be received from either ManDown or EmergencyAlert

open fun getLastMessageContainsLocationPins(@NonNull context: Context): BaseMessage

Call this method to retrieve the message which contains the last location attachment pins from local Database represented by BaseMessage object.

getLastMessageId

getMembersOfGroupConversation

open fun getLastMessageId(@NonNull context: Context, @NonNull conversationId: String): String

Call this method to retrieve the last inserted message id in the associated conversation from local Database.

open fun getMembersOfGroupConversation(@NonNull context: Context, @NonNull conversationId: String): List<PhoneItem>

Call this method to retrieve list of members in group conversation The given conversation should :

a group group conversation (THREAD_TYPE_GROUP).
exist and active.
not related to a MyBusiness process.
not an emergency conversation.

getMessageByAttachmentId

open fun getMessageByAttachmentId(@NonNull context: Context, @NonNull attachmentId: String): BaseMessage

Call this method to retrieve the message represented by BaseMessage object from local dataBase given an attachmentId

getMessageById

open fun getMessageById(@NonNull context: Context, @NonNull messageId: String): BaseMessage

Call this method to retrieve the message represented by BaseMessage object given a messageId.

getMessageList

open fun getMessageList( @NonNull context: Context, @NonNull conversationId: String, @IntRange(from = 0) startingFrom: Int, @IntRange(from = 1) numberOfMessage: Int): List<BaseMessage>

Call this method to retrieve message list from local Database in the right chronological order This method should be executed in a worker thread since it contains a lot of operation that can exceed 5sec or block the UI thread.

getMessagePosition

open fun getMessagePosition(@NonNull context: Context, @NonNull messageId: String): Int

Call this method to retrieve the message position in the associated conversation from local Database.

~~open~~ ~~fun~~ ~~getMessages~~( @NonNull context: Context, @NonNull conversationId: String, @IntRange(from = 0) startingFrom: Int, @IntRange(from = 1) numberOfMessage: Int): List<BaseMessage>

Call this method to retrieve message list from local Database.

getMessagesByType

getMessagesByTypeAndSession

open fun getMessagesByType( @NonNull context: Context, @NonNull conversationId: String, @NonNull messageType: List<String>, @IntRange(from = 0) startingFrom: Int, @IntRange(from = 1) numberOfMessage: Int): List<BaseMessage>

Call this method to retrieve message list from local Database by message type.

open fun getMessagesByTypeAndSession( @NonNull context: Context, @NonNull conversationId: String, @NonNull messageType: List<String>, @NonNull sessionTypes: List<Integer>, @IntRange(from = 0) startingFrom: Int, @IntRange(from = 1) numberOfMessage: Int): List<BaseMessage>

Call this method to retrieve message list from local Database by message type.

getMessageSender

getNumberOfAllMessagesByType

open fun getMessageSender(@NonNull context: Context, @NonNull messageId: String): String

Call This method to get the message sender phone number

open fun getNumberOfAllMessagesByType( @NonNull context: Context, @Nullable messageTypeList: List<String>, @NonNull sessionTypes: List<Integer>): Int

Call this method to retrieve the total number of all messages (except draft messages) by type from local Database.

getNumberOfCompanyConversations

open fun getNumberOfCompanyConversations(@NonNull context: Context): Int

Call this method to retrieve the total number of company conversations from local Database.

getNumberOfConversations

open fun getNumberOfConversations(@NonNull context: Context): Int

Call this method to retrieve the total number of conversations from local Database.

getNumberOfConversationsForRecipientGroupId

open fun getNumberOfConversationsForRecipientGroupId(@NonNull context: Context, @NonNull groupId: String): Int

Call this method to retrieve the number of the related conversations for a given groupId.

getNumberOfMessagesInConversation

open fun getNumberOfMessagesInConversation(@NonNull context: Context, @NonNull conversationId: String): Int

Call this method to retrieve the total number of messages (except draft messages) in a conversation from local Database given conversationId.

getNumberOfReceivedMessage

open fun getNumberOfReceivedMessage(@NonNull context: Context, date: Long): Int

Call this method to retrieve the number of messages received after the given date from local Database.

getNumberOfSentMessage

open fun getNumberOfSentMessage(@NonNull context: Context, date: Long): Int

Call this method to retrieve the number of messages sent after a given date from local Database.

getNumberOfUnreadConversation

open fun getNumberOfUnreadConversation(@NonNull context: Context): Int

Call this method to retrieve the number of unread conversations.

getNumberOfUnreadMessageInConversation

open fun getNumberOfUnreadMessageInConversation(@NonNull context: Context, @NonNull conversationId: String): Int

Call this method to retrieve the total number of unread message in the specified conversation from local Database.

getNumberOfUnreadMessages

open fun getNumberOfUnreadMessages(@NonNull context: Context): Int

Call this method to retrieve the total number of unread messages from local Database.

getOldestUnreadMessageIdInConversation

open fun getOldestUnreadMessageIdInConversation(@NonNull context: Context, @NonNull conversationId: String): Int

Call this method to retrieve the id of the oldest unread message in the associated conversation from local Database.

getOneToManyConversationByRecipients

getRecipientAdminRoleInGroupConversation

open fun getOneToManyConversationByRecipients(@NonNull context: Context, @NonNull recipients: Array<String>): ThreadItem

Call this method to retrieve a one to many conversation from local Database object given groups and users.

open fun getRecipientAdminRoleInGroupConversation( @NonNull context: Context, @NonNull recipientPhoneNumber: String, @NonNull conversationId: String): Int

Call this method to retrieve the recipient role in the group conversation The given conversation should :

be a group group conversation (THREAD_TYPE_GROUP).
exist and active.
not related to a MyBusiness process.
not an emergency conversation.

getRegularAdminsOfGroupConversation

getSendingFallBackMessageDelay

open fun getRegularAdminsOfGroupConversation(@NonNull context: Context, @NonNull conversationId: String): List<PhoneItem>

Call this method to retrieve list of regular administrator in group conversation The given conversation should :

a group group conversation (THREAD_TYPE_GROUP).
exist and active.
not related to a MyBusiness process.
not an emergency conversation.

open fun getSendingFallBackMessageDelay(@NonNull context: Context): Int

Call This method to get the fallBack message delay for sending timer "SendingTimer" during which we wait for the message to be sent to the server.

getSipMaxTextBodySize

open fun getSipMaxTextBodySize( @NonNull context: Context, withSipThumbnailAttachment: Boolean, thumbnailAttachmentSize: Long): Long

getThreadsByRecipients

open fun getThreadsByRecipients( @NonNull context: Context, @Nullable groups: List<ContactItem>, @Nullable phones: List<PhoneItem>): List<ThreadItem>

Call this method to retrieve all the conversations by the exact list of recipients (single user and group contacts)

getUsersInConversation

getVoiceMessageAudioSettings

open fun getUsersInConversation(@NonNull context: Context, @Nullable conversationId: String): List<PhoneItem>

Call this method to retrieve recipient users in the given conversation.

open fun getVoiceMessageAudioSettings(@NonNull context: Context): Int

CAll this method to choose whether you want play the voice message audio output on speaker or earpiece device.

handleDraftMessage

open fun handleDraftMessage( @NonNull context: Context, @Nullable conversationID: String, @Nullable text: String, @Nullable attachment: BaseAttachment, isAvailableOnlyRecipients: Boolean, @Nullable recipients: Array<String>, bearer: Int, @Nullable callback: CompletionCallback)

Call this method to add, update or remove drafts in conversations from local database.

hasMoreConversations

open fun hasMoreConversations(@NonNull context: Context): Boolean

Call this method to check if there are more conversations to retrieve from BE or no

hasMoreMessages

open fun hasMoreMessages(@NonNull context: Context, @NonNull conversationId: String): Boolean

Call this method to check if there is more messages to load for the current existing thread.

iMAdmin

open fun iMAdmin(@NonNull context: Context, @Nullable conversationId: String): Boolean

Call this method to check if i'm an administrator in a group conversation :

I'm an admin initiator
I'm a regular administrator.
or if the conversation without administrators, contains only groups

The given conversation should :

be a group group conversation (THREAD_TYPE_GROUP).
exist.
not related to a MyBusiness process.
not an emergency conversation.

inviteParticipants

open fun inviteParticipants( @NonNull context: Context, @NonNull invitedRecipients: Array<String>, @NonNull conversationId: String, @Nullable callback: STWOperationCallback<MessagingError>)

Call this method to invite new participants (users and/or groups) to the conversation.

isConversationSupportGroupAdmin

open fun isConversationSupportGroupAdmin(@NonNull context: Context, @NonNull conversationId: String): Boolean

Call this method to check whether the conversation supports the administrator group or not The given conversation should :

a group group conversation (THREAD_TYPE_GROUP).
exist and active.
not related to a MyBusiness process.
not an emergency conversation.
not related to a broadcast group call.

isImSendingAvailable

open fun isImSendingAvailable(): Boolean

Call this method to check if the device is able to send messages via IM "Instant messaging".

isMessageReadConfirmationEnabled

open fun isMessageReadConfirmationEnabled(@NonNull context: Context): Boolean

Call this method to check whether the seen message feature is enabled from user settings or not.

isMessageRequireAckAllowed

open fun isMessageRequireAckAllowed(@NonNull context: Context): Boolean

Call this method to check whether the message acknowledgement is enabled from user settings or not.

isSmsSendingAvailable

open fun isSmsSendingAvailable(): Boolean

Call this method to check if the device is able to send messages via SMS.

leaveGroupConversation

open fun leaveGroupConversation( @NonNull context: Context, @NonNull conversationId: String, @Nullable callback: STWOperationCallback<MessagingError>)

Call this method to leave a group conversation.

loadMessages

open fun loadMessages( @NonNull context: Context, @NonNull conversationId: String, @Nullable loadMessagesCallback: ILoadMessages)

Call this method to load messages of the given threadItem.

loadMoreMessages

readAllMessagesOfConversation

open fun loadMoreMessages( @NonNull context: Context, @NonNull conversationId: String, @Nullable loadMessagesCallback: ILoadMessages)

Call this method to load more messages of configured thread.

open fun readAllMessagesOfConversation( @NonNull context: Context, @NonNull conversationId: String, @Nullable callback: STWOperationCallback<MessagingError>)

Call this method to mark all messages of the conversation as read and synced with back-end.

readMessages

registerToMessagingSetting

open fun readMessages( @NonNull context: Context, @NonNull messageList: List<BaseMessage>, @Nullable callback: STWOperationCallback<MessagingError>)

Call this method to mark as read the given message list and synced with back-end.

registerToConversation

open fun registerToConversation(@NonNull conversationObservable: IConversationObservable)

open fun registerToConversation(@NonNull conversationId: String, @NonNull conversationObservable: IConversationObservable)

open fun registerToMessagingSetting(@NonNull messagingSettingsListener: IMessagingSettingsListener)

removeGroupsFromConversation

open fun removeGroupsFromConversation( @NonNull context: Context, @NonNull conversationId: String, @NonNull groups: List<String>, @Nullable callback: STWOperationCallback<MessagingError>)

Call this method to remove a group from a group conversation.

removeRegularAdmin

open fun removeRegularAdmin( @NonNull context: Context, @NonNull conversationId: String, @NonNull adminPhoneNumber: String, @Nullable callback: STWOperationCallback<MessagingError>)

Call this method to remove a regular admin from the current group conversation, means the adminPhoneNumber will be a simple member The given conversation should

be a group group conversation (THREAD_TYPE_GROUP).
exist and active.
not related to a MyBusiness process.
not an emergency conversation.

The given adminPhoneNumber should be present in the current group conversation as a regular admin

removeRegularAdmins

open fun removeRegularAdmins( @NonNull context: Context, @NonNull conversationId: String, @NonNull adminPhoneNumberList: List<String>, @Nullable callback: STWOperationCallback<MessagingError>)

Call this method to remove the regular admin list from the current group conversation, means the adminPhoneNumberList will be all a simple members The given conversation should

be a group group conversation (THREAD_TYPE_GROUP).
exist and active.
not related to a MyBusiness process.
not an emergency conversation.

The given adminPhoneNumberList should be present in the current group conversation as a regular admins

removeUserFromGroupConversation

open fun removeUserFromGroupConversation( @NonNull context: Context, @NonNull conversationId: String, @NonNull removedInternationalNumber: String, @Nullable callback: STWOperationCallback<MessagingError>)

Call this method to remove a user from a group conversation.

resendMessage

open fun resendMessage( @NonNull context: Context, @NonNull messageId: String, @Nullable completion: CompletionCallback)

Call this method to resend a failed message.

searchConversation

searchConversationContainsFile

open fun searchConversation(@NonNull context: Context, @NonNull searchKey: String): List<ThreadItem>

Call this method to search for conversation contains the given searchKey (search in message text contains the given searchKey).

searchExternalConversations

open fun searchConversationContainsFile(@NonNull context: Context, @Nullable searchKey: String): List<ThreadItem>

Call this method to search for any conversations contains a document or a file attachment given a searchKey.

setMessageAutoDeletionDate

open fun searchExternalConversations(@NonNull context: Context, @NonNull searchKey: String): List<ThreadItem>

Call this method to search for all call out conversation contains the given searchKey (search in message text contains the given searchKey).

sendMessage

open fun sendMessage( @Nullable message: String, @Nullable attachment: BaseAttachment, @NonNull conversationId: String, isRequireAcknowledgement: Boolean, bearer: Int, @Nullable completion: CompletionCallback)

Call this method to send a new message/attachment for an existing conversation.

open fun sendMessage( @Nullable message: String, @Nullable attachment: BaseAttachment, @NonNull recipients: Array<String>, conversationType: Int, @Nullable conversationName: String, isAvailableOnlyRecipients: Boolean, isRequireAcknowledgement: Boolean, bearer: Int, @Nullable completion: CompletionCallback)

Call this method to send a new message/attachment A new conversation will be created based on the users, groups and the conversationType parameters.

sendVoiceMessagePlayed

open fun sendVoiceMessagePlayed( @NonNull context: Context, @NonNull messageId: String, @Nullable callback: STWOperationCallback<MessagingError>)

Call this method to synchronize voice message play with the webChat.