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

Gets the custom data

Returns

  • type:

    Map<String, Object>

direct

Copy URL

bool

direct

Whether 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 cannot 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 returns the UUID of the already existing direct conversation.

A direct conversation cannot be uber and/or public.

Returns

  • type:

    bool

participants

Copy URL

List<VIConversationParticipant>

participants

Gets the list of conversation participants

Returns

publicJoin

Copy URL

bool

publicJoin

Whether 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 cannot be direct.

Returns

  • type:

    bool

title

Copy URL

String?

title

Gets the title

Returns

  • type:

    String?

uber

Copy URL

bool

uber

Whether a conversation is configured as uber or not.

Users in a uber conversation cannot retrieve messages that have been sent to the conversation after they quit.

A uber conversation cannot be direct.

Returns

  • type:

    bool