1. References
  2. IOS SDK
  3. client
  4. VIAuthParams
Rate this page:

Messenger

Methods

createConversation

Copy URL
- (
Promise<MessengerEventTypes.CreateConversation,MessengerEventTypes.Error>
)createConversation:(
ConversationConfig
)conversationConfig

Creates a new conversation with the extended configuration.Other parties of the conversation (online participants and logged in clients) can be informed about the conversation creation via the MessengerEventTypes.CreateConversation.

Parameters

  • conversationConfig:

    ConversationConfig

    Optional

    ConversationConfig instance with extended conversation parameters

Returns

editUser

Copy URL
- (
Promise<MessengerEventTypes.EditUser,MessengerEventTypes.Error>
)editUser:(
object
)customData

Edits the current user information.Other users that are subscribed to the user can be informed about the editing via the MessengerEventTypes.EditUser event.

Parameters

  • customData:

    object

    Optional

    New custom data. If null, previously set custom data is not to be changed. If empty object, previously set custom data is removed.

  • privateCustomData:

    object

    Optional

    New private custom data. If null, previously set private custom data is not to be changed. If empty object, previously set private custom data is removed.

Returns

getConversation

Copy URL
- (
Promise<MessengerEventTypes.GetConversation,MessengerEventTypes.Error>
)getConversation:(
string
)uuid

Gets a conversation by its UUID.It is possible if:

  • the user that calls the method is/has been a participant of this conversation
  • the conversation is an available public conversation (see Messenger.getPublicConversations)

Only the client that called the method can be informed about getting conversation.

Parameters

  • uuid:

    string

    Conversation UUID

Returns

getConversations

Copy URL
- (
Promise<MessengerEventTypes.GetConversation[],MessengerEventTypes.Error>
)getConversations:(
string[]
)uuids

Gets the multiple conversations by the list of UUIDs. Maximum 30 conversations.It is possible if:

  • the user that calls the method is/has been a participant of this conversation
  • the conversation is an available public conversation (see [Messenger#getPublicConversations])

Only the client that called the method can be informed about getting conversations.

Parameters

  • uuids:

    string[]

    Array of UUIDs. Maximum 30 conversations.

Returns

getMe

Copy URL
- (
string
 | 
null
)getMe

Gets the full Voximplant user identifier, for example 'username@appname.accname', for the current user.

Returns

  • type:

    string

  • type:

    null

getPublicConversations

Copy URL
- (
Promise<MessengerEventTypes.GetPublicConversations,MessengerEventTypes.Error>
)getPublicConversations

Gets all public conversations (Conversation.publicJoin is true).It is possible to get all public conversations (UUIDs) that have been created by:

  • the current user
  • other users of the same child account
  • users of the main Voximplant developer account

Only the client that called the method can be informed about getting public conversations UUIDs.

Returns

getSubscriptions

Copy URL
- (
Promise<MessengerEventTypes.GetSubscriptions,MessengerEventTypes.Error>
)getSubscriptions

Gets all current subscriptions, i.e., the array of users the current user is subscribed to.Only the client that called the method can be informed about getting subscriptions.

Returns

getUserByIMId

Copy URL
- (
Promise<MessengerEventTypes.GetUser,MessengerEventTypes.Error>
)getUserByIMId:(
number
)userId

Gets information for the user specified by the IM user id.It is possible to get any user of the main Voximplant developer account or its child accounts.

Only the client that called the method can be informed about getting user information.

Parameters

  • userId:

    number

    IM User id

Returns

getUserByName

Copy URL
- (
Promise<MessengerEventTypes.GetUser,MessengerEventTypes.Error>
)getUserByName:(
string
)username

Gets information for the user specified by the Voximplant user name, e.g., 'username@appname.accname'.It is possible to get any user of the main Voximplant developer account or its child accounts.

Only the client that called the method can be informed about getting user information.

Parameters

  • username:

    string

    Voximplant user identifier

Returns

getUsersByIMId

Copy URL
- (
Promise<MessengerEventTypes.GetUser[],MessengerEventTypes.Error>
)getUsersByIMId:(
number[]
)users

Gets information for the users specified by the array of the IM user ids. Maximum 50 users.It is possible to get any users of the main Voximplant developer account or its child accounts.

Only the client that called the method can be informed about getting users information.

Parameters

  • users:

    number[]

    Array of IM user ids

Returns

getUsersByName

Copy URL
- (
Promise<MessengerEventTypes.GetUser[],MessengerEventTypes.Error>
)getUsersByName:(
string[]
)users

Gets information for the users specified by the array of the Voximplant user names. Maximum 50 users.It is possible to get any users of the main Voximplant developer account or its child accounts.

Only the client that called the method can be informed about getting users information.

Parameters

  • users:

    string[]

    Array of Voximplant user identifiers

Returns

joinConversation

Copy URL
- (
Promise<MessengerEventTypes.EditConversation,MessengerEventTypes.Error>
)joinConversation:(
string
)uuid

Joins the current user to any conversation specified by the UUID.It is possible only on the following conditions:

  • a conversation is created by a user of the main Voximplant developer account or its child accounts
  • public join is enabled (Conversation.publicJoin is true)
  • the conversation is not a direct one (Conversation.direct is false)

Other parties of the conversation (online participants and logged in clients) can be informed about joining to the conversation via the MessengerEventTypes.EditConversation event.

Parameters

  • uuid:

    string

    Conversation UUID

Returns

leaveConversation

Copy URL
- (
Promise<MessengerEventTypes.EditConversation,MessengerEventTypes.Error>
)leaveConversation:(
string
)uuid

Makes the current user leave a conversation specified by the UUID.It is possible only if the conversation is not a direct one (Conversation.direct is false).

After a successful method call the conversation's UUID is added to User.leaveConversationList.

Other parties of the conversation (online participants and logged in clients) can be informed about leaving the conversation via the MessengerEventTypes.EditConversation event.

Parameters

  • uuid:

    string

    Conversation UUID

Returns

managePushNotifications

Copy URL
- (
Promise<MessengerEventTypes.EditUser,MessengerEventTypes.Error>
)managePushNotifications:(
MessengerNotification[]
)notifications

Manages messenger push notification subscriptions for the current user.Other logged in clients (of the current user) can be informed about managing push notifications via MessengerEventTypes.EditUser

Parameters

Returns

off

Copy URL
- (
void
)off:(
MessengerEventTypes
)eventType

Removes a handler for specified event.

Parameters

  • eventType:

    MessengerEventTypes

  • event:

    Function

    Optional

    Handler function. If not specified, all handlers for the event type are removed.

Returns

  • type:

    void

on

Copy URL
- (
void
)on:(
MessengerEventTypes
)eventType

Registers a handler for specified messenger event. Use Messenger.off method to delete a handler.

Parameters

Returns

  • type:

    void

setStatus

Copy URL
- (
Promise<MessengerEventTypes.SetStatus,MessengerEventTypes.Error>
)setStatus:(
boolean
)online

Sets the current user status.Other users (that are subscribed to the user) and other clients (of the current user) can be informed about the status changing via the MessengerEventTypes.SetStatus event.

Parameters

  • online:

    boolean

    Whether the user is available for messaging

Returns

subscribe

Copy URL
- (
Promise<MessengerEventTypes.Subscribe,MessengerEventTypes.Error>
)subscribe:(
number[]
)users

Subscribes for other user(s) information and status changes.It is possible to subscribe for any user of the main Voximplant developer account or its child accounts.

Other logged in clients (of the current user) can be informed about the subscription via the MessengerEventTypes.Subscribe event.

User(s) specified in the 'users' parameter are not informed about the subscription.

Parameters

  • users:

    number[]

    Array of IM user ids

Returns

unsubscribe

Copy URL
- (
Promise<MessengerEventTypes.Unsubscribe,MessengerEventTypes.Error>
)unsubscribe:(
number[]
)users

Unsubscribes from other user(s) information and status changes.Other logged in clients (of the current user) can be informed about the unsubscription via the MessengerEventTypes.Unsubscribe event.

User(s) specified in the 'users' parameter are not informed about the unsubscription.

Parameters

  • users:

    number[]

    Array of IM user ids

Returns

unsubscribeFromAll

Copy URL
- (
Promise<MessengerEventTypes.Unsubscribe,MessengerEventTypes.Error>
)unsubscribeFromAll

Unsubscribes from all subscriptions.Other logged in clients (of the current user) can be informed about the unsubscription via the MessengerEventTypes.Unsubscribe event.

Other users are not informed about the unsubscription.

Returns