ChatRoomParams

public class ChatRoomParams : LinphoneObject

Object defining parameters for a ChatRoom. Can be created with Core.createDefaultChatRoomParams(). You can use isValid() to check if your configuration is valid or not. If the ChatRoom backend is Basic, then no other parameter is required, but ChatMessage sent and received won’t benefit from all features a FlexisipChat can offer like conversation with multiple participants and a subject, end-to-end encryption, ephemeral messages, etc… but this type is the only one that can interoperate with other SIP clients or with non-flexisip SIP proxies.

  • Undocumented

    Declaration

    Swift

    public static func getSwiftObject(cObject: OpaquePointer) -> ChatRoomParams
  • Undocumented

    Declaration

    Swift

    public var getCobject: OpaquePointer? { get }
  • Get the backend implementation of the chat room associated with the given parameters.

    Declaration

    Swift

    public var backend: ChatRoomBackend { get set }

    Return Value

    the ChatRoomBackend

  • Get the encryption implementation of the chat room associated with the given parameters.

    Declaration

    Swift

    public var encryptionBackend: ChatRoomEncryptionBackend { get set }

    Return Value

    the ChatRoomEncryptionBackend

  • Get the encryption status of the chat room associated with the given parameters.

    Declaration

    Swift

    public var encryptionEnabled: Bool { get set }

    Return Value

    true if encryption is enabled, false otherwise

  • Get lifetime (in seconds) for all new ephemeral messages in the chat room. After the message is read, it will be deleted after “time” seconds. - See also: linphone_chat_room_params_ephemeral_enabled()

    Declaration

    Swift

    public var ephemeralLifetime: Int { get set }

    Return Value

    the ephemeral lifetime (in seconds)

  • Get the ephemeral message mode of the chat room associated with the given parameters.

    Declaration

    Swift

    public var ephemeralMode: ChatRoomEphemeralMode { get set }

    Return Value

    the ephemeral message mode ChatRoomEphemeralMode

  • Get the group chat status of the chat room associated with the given parameters.

    Declaration

    Swift

    public var groupEnabled: Bool { get set }

    Return Value

    true if group chat is enabled, false if one-to-one

  • Returns whether the given parameters are valid or not.

    Declaration

    Swift

    public var isValid: Bool { get }

    Return Value

    true if the given parameters are valid, false otherwise

  • Get the real time text status of the chat room associated with the given parameters.

    Declaration

    Swift

    public var rttEnabled: Bool { get set }

    Return Value

    true if real time text is enabled, false otherwise

  • Get the subject of the chat room.

    Declaration

    Swift

    public var subject: String { get set }

    Return Value

    The subject.