SIGN UP

VIUser

Interface that represents user information. Voximplant users are created via the Voximplant control panel or HTTP API.

Properties

conversationList

@property (nonatomic, strong, readonly, nullable) NSArray<NSString *> *conversationList

An array of UUIDs of the conversations that the user currently belongs to.

Can be empty array if user doesn't belong to any conversation or nil if this property is accessed not for the current user.

customData

@property (nonatomic, strong, readonly) NSDictionary<NSString *, NSObject *> *customData

The specified user's public custom data available to all users.

A custom data can be set via the [VIMessenger editUserWithCustomData:privateCustomData:completion:] method.

deleted

@property (nonatomic, assign, readonly, getter=isDeleted) BOOL deleted

A Boolean value that determines whether the user is deleted or not.

displayName

@property (nonatomic, strong, readonly) NSString *displayName

The user's display name which is specified during user creation via the Voximplant control panel or HTTP API.

The display name is available to all users.

imId

@property (nonatomic, strong, readonly) NSNumber *imId

The IM unique id that is used to identify users in events and specify in user-related methods.

leaveConversationList

@property (nonatomic, strong, readonly, nullable) NSArray<NSString *> *leaveConversationList

An array of UUIDs for the conversations that:

  • the user belonged to, but currently is not participating in
  • are not removed

Can be empty array if user didn't leave any conversation or nil if this property is accessed not for the current user.

name

@property (nonatomic, strong, readonly) NSString *name

The Voximplant user identifier, for example 'username@appname.accname'.

notifications

@property (nonatomic, strong, readonly, nullable) NSArray<VIMessengerNotification> *notifications

An array of messenger notifications that the current user is subscribed to.

Note that if the property is accessed not for the current user, the result will be nil.

privateCustomData

@property (nonatomic, strong, readonly, nullable) NSDictionary<NSString *, NSObject *> *privateCustomData

A private custom data available only to the current user.

Value of this property is nil if this property is accessed not for the current user.