Rate this page:

VIConversationConfig

Configuration either to create a new conversation or restore a previously created conversation:

Constructors

VIConversationConfig

Copy URL

Parameters

  • direct:

    bool

    Optional
  • publicJoin:

    bool

    Optional
  • uber:

    bool

    Optional
  • title:

    String

    Optional
  • customData:

    Map<String, Object>

    Optional
  • participants:

    List<VIConversationParticipant>

    Optional

Props

customData

Copy URL

Map<String, Object>

customData

Get the custom data

Returns

  • type:

    Map<String, Object>

direct

Copy URL

bool

direct

Check if a conversation is configured as direct or not.

There can be only 2 participants in a direct conversation which is unique and the only one for these participants. There can't be more than 1 direct conversation for the same 2 users.

If one of these users tries to create a new direct conversation with the same participant via VIMessenger.createConversation, the method will return the UUID of the already existing direct conversation.

A direct conversation can't be uber and/or public.

Returns

  • type:

    bool

participants

Copy URL

List<VIConversationParticipant>

participants

Get the list of conversation participants

Returns

publicJoin

Copy URL

bool

publicJoin

Check if a conversation is configured as public or not.

If true, any user can join the conversation via VIMessenger.joinConversation by specifying its UUID. Use the VIMessenger.getPublicConversations method to retrieve all public conversations' UUIDs.

A public conversation can't be direct.

Returns

  • type:

    bool

title

Copy URL

String

title

Get the title

Returns

  • type:

    String

uber

Copy URL

bool

uber

Check if a conversation is configured as uber or not.

Users in a uber conversation will not be able to retrieve messages that were sent to the conversation after they quit.

A uber conversation can't be direct.

Returns

  • type:

    bool