Rate this page:

VIConversationConfig

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

Props

customData

Copy URL
@property (copy, nonatomic) 

NSDictionary<NSString *, NSObject *> *

customData

Specify a custom data of the conversation (up to 5kb).

The custom data can be later changed via [VIConversation customData].

Returns

  • type:

    NSDictionary<NSString *, NSObject *> *

direct

Copy URL
@property (assign, nonatomic, getter = isDirect) 

BOOL

direct

A Boolean value that determines whether the conversation is direct.

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:completion:], 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
@property (copy, nonatomic) 

NSArray<VIConversationParticipant *> *

participants

A conversation participants.

The participants array can be later changed via:

Returns

publicJoin

Copy URL
@property (assign, nonatomic, getter = isPublicJoin) 

BOOL

publicJoin

A Boolean value that determines whether the conversation is public.

It can be later changed via [VIConversation publicJoin].

If true, any user can join the conversation via [VIMessenger joinConversation:completion:] 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
@property (copy, nonatomic) 

NSString *

title

A conversation title.

It can be later changed via [VIConversation title].

Returns

  • type:

    NSString *

uber

Copy URL
@property (assign, nonatomic, getter = isUber) 

BOOL

uber

A Boolean value that determines whether the conversation is uber.

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

A uber conversation can't be direct.

Returns

  • type:

    BOOL