• Api Documentation
Show / Hide Table of Contents
  • Linphone
    • Account
    • AccountCreator
    • AccountCreatorActivationCodeStatus
    • AccountCreatorAlgoStatus
    • AccountCreatorBackend
    • AccountCreatorDomainStatus
    • AccountCreatorEmailStatus
    • AccountCreatorLanguageStatus
    • AccountCreatorListener
    • AccountCreatorListener.OnAccountCreationRequestTokenDelegate
    • AccountCreatorListener.OnAccountCreationTokenUsingRequestTokenDelegate
    • AccountCreatorListener.OnActivateAccountDelegate
    • AccountCreatorListener.OnActivateAliasDelegate
    • AccountCreatorListener.OnCreateAccountDelegate
    • AccountCreatorListener.OnIsAccountActivatedDelegate
    • AccountCreatorListener.OnIsAccountExistDelegate
    • AccountCreatorListener.OnIsAccountLinkedDelegate
    • AccountCreatorListener.OnIsAliasUsedDelegate
    • AccountCreatorListener.OnLinkAccountDelegate
    • AccountCreatorListener.OnLoginLinphoneAccountDelegate
    • AccountCreatorListener.OnRecoverAccountDelegate
    • AccountCreatorListener.OnSendTokenDelegate
    • AccountCreatorListener.OnUpdateAccountDelegate
    • AccountCreatorPasswordStatus
    • AccountCreatorPhoneNumberStatus
    • AccountCreatorStatus
    • AccountCreatorTransportStatus
    • AccountCreatorUsernameStatus
    • AccountDevice
    • AccountListener
    • AccountListener.OnConferenceInformationUpdatedDelegate
    • AccountListener.OnMessageWaitingIndicationChangedDelegate
    • AccountListener.OnRegistrationStateChangedDelegate
    • AccountManagerServices
    • AccountManagerServicesRequest
    • AccountManagerServicesRequestListener
    • AccountManagerServicesRequestListener.OnDevicesListFetchedDelegate
    • AccountManagerServicesRequestListener.OnRequestErrorDelegate
    • AccountManagerServicesRequestListener.OnRequestSuccessfulDelegate
    • AccountManagerServicesRequestType
    • AccountParams
    • Address
    • AddressFamily
    • Alert
    • AlertListener
    • AlertListener.OnTerminatedDelegate
    • AlertType
    • AudioDevice
    • AudioDeviceCapabilities
    • AudioDeviceType
    • AuthInfo
    • AuthMethod
    • AVPFMode
    • BaudotMode
    • BaudotStandard
    • BearerToken
    • Buffer
    • Call
    • CallDir
    • CallListener
    • CallListener.OnAckProcessingDelegate
    • CallListener.OnAudioDeviceChangedDelegate
    • CallListener.OnAuthenticationTokenVerifiedDelegate
    • CallListener.OnBaudotDetectedDelegate
    • CallListener.OnCameraNotWorkingDelegate
    • CallListener.OnDtmfReceivedDelegate
    • CallListener.OnEncryptionChangedDelegate
    • CallListener.OnGoclearAckSentDelegate
    • CallListener.OnHeadsetAnswerCallRequestedDelegate
    • CallListener.OnHeadsetEndCallRequestedDelegate
    • CallListener.OnHeadsetHoldCallRequestedDelegate
    • CallListener.OnHeadsetMicrophoneMuteToggledDelegate
    • CallListener.OnHeadsetRejectCallRequestedDelegate
    • CallListener.OnHeadsetResumeCallRequestedDelegate
    • CallListener.OnInfoMessageReceivedDelegate
    • CallListener.OnNextVideoFrameDecodedDelegate
    • CallListener.OnReceiveMasterKeyChangedDelegate
    • CallListener.OnReferRequestedDelegate
    • CallListener.OnRemoteRecordingDelegate
    • CallListener.OnSecurityLevelDowngradedDelegate
    • CallListener.OnSendMasterKeyChangedDelegate
    • CallListener.OnSnapshotTakenDelegate
    • CallListener.OnStateChangedDelegate
    • CallListener.OnStatsUpdatedDelegate
    • CallListener.OnTmmbrReceivedDelegate
    • CallListener.OnTransferStateChangedDelegate
    • CallListener.OnVideoDisplayErrorOccurredDelegate
    • CallLog
    • CallParams
    • CallState
    • CallStats
    • CallStatus
    • CardDavParams
    • ChatMessage
    • ChatMessageDirection
    • ChatMessageListener
    • ChatMessageListener.OnContentEditedDelegate
    • ChatMessageListener.OnEphemeralMessageDeletedDelegate
    • ChatMessageListener.OnEphemeralMessageTimerStartedDelegate
    • ChatMessageListener.OnFileTransferProgressIndicationDelegate
    • ChatMessageListener.OnFileTransferRecvDelegate
    • ChatMessageListener.OnFileTransferSendChunkDelegate
    • ChatMessageListener.OnFileTransferSendDelegate
    • ChatMessageListener.OnFileTransferTerminatedDelegate
    • ChatMessageListener.OnMsgStateChangedDelegate
    • ChatMessageListener.OnNewMessageReactionDelegate
    • ChatMessageListener.OnParticipantImdnStateChangedDelegate
    • ChatMessageListener.OnReactionRemovedDelegate
    • ChatMessageListener.OnRetractedDelegate
    • ChatMessageReaction
    • ChatMessageState
    • ChatParams
    • ChatRoom
    • ChatRoomBackend
    • ChatRoomCapabilities
    • ChatRoomEncryptionBackend
    • ChatRoomEphemeralMode
    • ChatRoomHistoryFilter
    • ChatRoomListener
    • ChatRoomListener.OnChatMessageParticipantImdnStateChangedDelegate
    • ChatRoomListener.OnChatMessageReceivedDelegate
    • ChatRoomListener.OnChatMessageSendingDelegate
    • ChatRoomListener.OnChatMessageSentDelegate
    • ChatRoomListener.OnChatMessageShouldBeStoredDelegate
    • ChatRoomListener.OnChatMessagesReceivedDelegate
    • ChatRoomListener.OnChatRoomReadDelegate
    • ChatRoomListener.OnConferenceAddressGenerationDelegate
    • ChatRoomListener.OnConferenceJoinedDelegate
    • ChatRoomListener.OnConferenceLeftDelegate
    • ChatRoomListener.OnEphemeralEventDelegate
    • ChatRoomListener.OnEphemeralMessageDeletedDelegate
    • ChatRoomListener.OnEphemeralMessageTimerStartedDelegate
    • ChatRoomListener.OnIsComposingReceivedDelegate
    • ChatRoomListener.OnMessageContentEditedDelegate
    • ChatRoomListener.OnMessageEarlyFailureDelegate
    • ChatRoomListener.OnMessageReceivedDelegate
    • ChatRoomListener.OnMessageRetractedDelegate
    • ChatRoomListener.OnMessagesReceivedDelegate
    • ChatRoomListener.OnNewEventDelegate
    • ChatRoomListener.OnNewEventsDelegate
    • ChatRoomListener.OnNewMessageReactionDelegate
    • ChatRoomListener.OnOperationFailedDelegate
    • ChatRoomListener.OnParticipantAddedDelegate
    • ChatRoomListener.OnParticipantAdminStatusChangedDelegate
    • ChatRoomListener.OnParticipantDeviceAddedDelegate
    • ChatRoomListener.OnParticipantDeviceMediaAvailabilityChangedDelegate
    • ChatRoomListener.OnParticipantDeviceRemovedDelegate
    • ChatRoomListener.OnParticipantDeviceStateChangedDelegate
    • ChatRoomListener.OnParticipantRegistrationSubscriptionRequestedDelegate
    • ChatRoomListener.OnParticipantRegistrationUnsubscriptionRequestedDelegate
    • ChatRoomListener.OnParticipantRemovedDelegate
    • ChatRoomListener.OnSecurityEventDelegate
    • ChatRoomListener.OnStateChangedDelegate
    • ChatRoomListener.OnSubjectChangedDelegate
    • ChatRoomListener.OnUndecryptableMessageReceivedDelegate
    • ChatRoomParams
    • ChatRoomSecurityLevel
    • ChatRoomState
    • CodecPriorityPolicy
    • ComposingParticipant
    • Conference
    • ConferenceInfo
    • ConferenceInfoState
    • ConferenceJoiningMode
    • ConferenceLayout
    • ConferenceListener
    • ConferenceListener.OnActiveSpeakerParticipantDeviceDelegate
    • ConferenceListener.OnAllowedParticipantListChangedDelegate
    • ConferenceListener.OnAudioDeviceChangedDelegate
    • ConferenceListener.OnAvailableMediaChangedDelegate
    • ConferenceListener.OnFullStateReceivedDelegate
    • ConferenceListener.OnOperationFailedDelegate
    • ConferenceListener.OnParticipantAddedDelegate
    • ConferenceListener.OnParticipantAdminStatusChangedDelegate
    • ConferenceListener.OnParticipantDeviceAddedDelegate
    • ConferenceListener.OnParticipantDeviceIsMutedDelegate
    • ConferenceListener.OnParticipantDeviceIsSpeakingChangedDelegate
    • ConferenceListener.OnParticipantDeviceJoiningRequestDelegate
    • ConferenceListener.OnParticipantDeviceMediaAvailabilityChangedDelegate
    • ConferenceListener.OnParticipantDeviceMediaCapabilityChangedDelegate
    • ConferenceListener.OnParticipantDeviceRemovedDelegate
    • ConferenceListener.OnParticipantDeviceScreenSharingChangedDelegate
    • ConferenceListener.OnParticipantDeviceStateChangedDelegate
    • ConferenceListener.OnParticipantRemovedDelegate
    • ConferenceListener.OnParticipantRoleChangedDelegate
    • ConferenceListener.OnStateChangedDelegate
    • ConferenceListener.OnSubjectChangedDelegate
    • ConferenceParams
    • ConferenceParticipantListType
    • ConferenceScheduler
    • ConferenceSchedulerListener
    • ConferenceSchedulerListener.OnInvitationsSentDelegate
    • ConferenceSchedulerListener.OnStateChangedDelegate
    • ConferenceSchedulerState
    • ConferenceSchedulerType
    • ConferenceSecurityLevel
    • ConferenceState
    • Config
    • ConfiguringState
    • ConsolidatedPresence
    • Content
    • Core
    • Core.MSOglContextInfo
    • CoreListener
    • CoreListener.OnAccountAddedDelegate
    • CoreListener.OnAccountRegistrationStateChangedDelegate
    • CoreListener.OnAccountRemovedDelegate
    • CoreListener.OnAudioDeviceChangedDelegate
    • CoreListener.OnAudioDevicesListUpdatedDelegate
    • CoreListener.OnAuthenticationRequestedDelegate
    • CoreListener.OnBuddyInfoUpdatedDelegate
    • CoreListener.OnCallCreatedDelegate
    • CoreListener.OnCallEncryptionChangedDelegate
    • CoreListener.OnCallGoclearAckSentDelegate
    • CoreListener.OnCallIdUpdatedDelegate
    • CoreListener.OnCallLogUpdatedDelegate
    • CoreListener.OnCallReceiveMasterKeyChangedDelegate
    • CoreListener.OnCallSendMasterKeyChangedDelegate
    • CoreListener.OnCallStateChangedDelegate
    • CoreListener.OnCallStatsUpdatedDelegate
    • CoreListener.OnChatRoomEphemeralMessageDeletedDelegate
    • CoreListener.OnChatRoomReadDelegate
    • CoreListener.OnChatRoomSessionStateChangedDelegate
    • CoreListener.OnChatRoomStateChangedDelegate
    • CoreListener.OnChatRoomSubjectChangedDelegate
    • CoreListener.OnConferenceInfoReceivedDelegate
    • CoreListener.OnConferenceStateChangedDelegate
    • CoreListener.OnConfiguringStatusDelegate
    • CoreListener.OnDefaultAccountChangedDelegate
    • CoreListener.OnDtmfReceivedDelegate
    • CoreListener.OnEcCalibrationAudioInitDelegate
    • CoreListener.OnEcCalibrationAudioUninitDelegate
    • CoreListener.OnEcCalibrationResultDelegate
    • CoreListener.OnFirstCallStartedDelegate
    • CoreListener.OnFriendListCreatedDelegate
    • CoreListener.OnFriendListRemovedDelegate
    • CoreListener.OnGlobalStateChangedDelegate
    • CoreListener.OnImeeUserRegistrationDelegate
    • CoreListener.OnInfoReceivedDelegate
    • CoreListener.OnIsComposingReceivedDelegate
    • CoreListener.OnLastCallEndedDelegate
    • CoreListener.OnLogCollectionUploadProgressIndicationDelegate
    • CoreListener.OnLogCollectionUploadStateChangedDelegate
    • CoreListener.OnMessageContentEditedDelegate
    • CoreListener.OnMessageReceivedDelegate
    • CoreListener.OnMessageReceivedUnableDecryptDelegate
    • CoreListener.OnMessageRetractedDelegate
    • CoreListener.OnMessageSentDelegate
    • CoreListener.OnMessagesReceivedDelegate
    • CoreListener.OnMessageWaitingIndicationChangedDelegate
    • CoreListener.OnNetworkReachableDelegate
    • CoreListener.OnNewAlertTriggeredDelegate
    • CoreListener.OnNewMessageReactionDelegate
    • CoreListener.OnNewSubscriptionRequestedDelegate
    • CoreListener.OnNotifyPresenceReceivedDelegate
    • CoreListener.OnNotifyPresenceReceivedForUriOrTelDelegate
    • CoreListener.OnNotifyReceivedDelegate
    • CoreListener.OnNotifySentDelegate
    • CoreListener.OnPreviewDisplayErrorOccurredDelegate
    • CoreListener.OnPublishReceivedDelegate
    • CoreListener.OnPublishStateChangedDelegate
    • CoreListener.OnPushNotificationReceivedDelegate
    • CoreListener.OnQrcodeFoundDelegate
    • CoreListener.OnReactionRemovedDelegate
    • CoreListener.OnReferReceivedDelegate
    • CoreListener.OnRegistrationStateChangedDelegate
    • CoreListener.OnRemainingNumberOfFileTransferChangedDelegate
    • CoreListener.OnSnapshotTakenDelegate
    • CoreListener.OnSubscribeReceivedDelegate
    • CoreListener.OnSubscriptionStateChangedDelegate
    • CoreListener.OnTransferStateChangedDelegate
    • CoreListener.OnVersionUpdateCheckResultReceivedDelegate
    • CoreLogCollectionUploadState
    • DialPlan
    • Dictionary
    • DigestAuthenticationPolicy
    • EcCalibratorStatus
    • EktInfo
    • EphemeralChatMessagePolicy
    • ErrorInfo
    • Event
    • EventListener
    • EventListener.OnNotifyReceivedDelegate
    • EventListener.OnNotifyResponseDelegate
    • EventListener.OnPublishReceivedDelegate
    • EventListener.OnPublishStateChangedDelegate
    • EventListener.OnSubscribeReceivedDelegate
    • EventListener.OnSubscribeStateChangedDelegate
    • EventLog
    • EventLogType
    • Factory
    • Friend
    • FriendCapability
    • FriendDevice
    • FriendList
    • FriendListener
    • FriendListener.OnPresenceReceivedDelegate
    • FriendListListener
    • FriendListListener.OnContactCreatedDelegate
    • FriendListListener.OnContactDeletedDelegate
    • FriendListListener.OnContactUpdatedDelegate
    • FriendListListener.OnNewSipAddressDiscoveredDelegate
    • FriendListListener.OnPresenceReceivedDelegate
    • FriendListListener.OnSyncStatusChangedDelegate
    • FriendListStatus
    • FriendListSyncStatus
    • FriendListType
    • FriendPhoneNumber
    • GlobalState
    • Headers
    • IceState
    • ImNotifPolicy
    • InfoMessage
    • Ldap
    • LdapAuthMethod
    • LdapCertVerificationMode
    • LdapCheck
    • LdapDebugLevel
    • LdapParams
    • LimeState
    • LinphoneException
    • LinphoneObject
    • LinphoneWrapper
    • LogCollectionState
    • LoggingService
    • LoggingServiceListener
    • LoggingServiceListener.OnLogMessageWrittenDelegate
    • LogLevel
    • MagicSearch
    • MagicSearchAggregation
    • MagicSearchListener
    • MagicSearchListener.OnLdapHaveMoreResultsDelegate
    • MagicSearchListener.OnMoreResultsAvailableDelegate
    • MagicSearchListener.OnResultsLimitReachedDelegate
    • MagicSearchListener.OnSearchResultsReceivedDelegate
    • MagicSearchSource
    • MediaDirection
    • MediaEncryption
    • MediaFileFormat
    • MediaResourceMode
    • MediastreamerFactory
    • MessageWaitingIndication
    • MessageWaitingIndicationContextClass
    • MessageWaitingIndicationSummary
    • NatPolicy
    • Participant
    • ParticipantDevice
    • ParticipantDeviceDisconnectionMethod
    • ParticipantDeviceIdentity
    • ParticipantDeviceJoiningMethod
    • ParticipantDeviceListener
    • ParticipantDeviceListener.OnIsMutedDelegate
    • ParticipantDeviceListener.OnIsSpeakingChangedDelegate
    • ParticipantDeviceListener.OnScreenSharingChangedDelegate
    • ParticipantDeviceListener.OnStateChangedDelegate
    • ParticipantDeviceListener.OnStreamAvailabilityChangedDelegate
    • ParticipantDeviceListener.OnStreamCapabilityChangedDelegate
    • ParticipantDeviceListener.OnThumbnailStreamAvailabilityChangedDelegate
    • ParticipantDeviceListener.OnThumbnailStreamCapabilityChangedDelegate
    • ParticipantDeviceListener.OnVideoDisplayErrorOccurredDelegate
    • ParticipantDeviceState
    • ParticipantImdnState
    • ParticipantInfo
    • ParticipantRole
    • PayloadType
    • Player
    • PlayerListener
    • PlayerListener.OnEofReachedDelegate
    • PlayerState
    • PresenceActivity
    • PresenceActivityType
    • PresenceBasicStatus
    • PresenceModel
    • PresenceNote
    • PresencePerson
    • PresenceService
    • Privacy
    • ProxyConfig
    • PublishState
    • PushNotificationConfig
    • PushNotificationMessage
    • Range
    • Reason
    • Recorder
    • RecorderParams
    • RecorderState
    • RegistrationState
    • RemoteContactDirectory
    • RemoteContactDirectoryType
    • SearchDirection
    • SearchResult
    • SecurityEventType
    • SecurityLevel
    • SessionExpiresRefresher
    • SignalInformation
    • SignalStrengthUnit
    • SignalType
    • SrtpSuite
    • StreamType
    • SubscribePolicy
    • SubscriptionDir
    • SubscriptionState
    • SupportLevel
    • ToneID
    • Transports
    • TransportType
    • Tunnel
    • TunnelConfig
    • TunnelMode
    • UpnpState
    • Vcard
    • VersionUpdateCheckResult
    • VideoActivationPolicy
    • VideoDefinition
    • VideoSourceDescriptor
    • VideoSourceScreenSharingType
    • VideoSourceType
    • XmlRpcArgType
    • XmlRpcRequest
    • XmlRpcRequestListener
    • XmlRpcRequestListener.OnResponseDelegate
    • XmlRpcSession
    • XmlRpcStatus
    • ZrtpKeyAgreement
    • ZrtpPeerStatus

Class ChatRoomParams

Object defining parameters for a Linphone.ChatRoom.

Can be created with Linphone.Core.CreateDefaultChatRoomParams(). You can use Linphone.ChatRoomParams.IsValid() to check if your configuration is valid or not. If the Linphone.ChatRoom backend is Linphone.ChatRoomBackend.Basic, then no other parameter is required, but Linphone.ChatMessage sent and received won't benefit from all features a Linphone.ChatRoomBackend.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.

Inheritance
System.Object
LinphoneObject
ChatRoomParams
Inherited Members
LinphoneObject.linphone_pointer_to_string(IntPtr)
LinphoneObject.linphone_string_to_pointer(String)
LinphoneObject.StringArrayToBctbxList(IEnumerable<String>)
LinphoneObject.CleanStringArrayPtrs(IntPtr)
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Linphone
Assembly: cs.temp.dll.dll
Syntax
public class ChatRoomParams : LinphoneObject

Properties

Backend

Get the backend implementation of the chat room associated with the given parameters.

Declaration
[Obsolete]
public ChatRoomBackend Backend { get; set; }
Property Value
Type Description
ChatRoomBackend

the Linphone.ChatRoomBackend

Remarks

Deprecated : 20/05/2024. Use Linphone.ChatParams.Backend instead.

EncryptionBackend

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

Declaration
[Obsolete]
public ChatRoomEncryptionBackend EncryptionBackend { get; set; }
Property Value
Type Description
ChatRoomEncryptionBackend

the Linphone.ChatRoomEncryptionBackend

Remarks

Deprecated : 20/05/2024. Use Linphone.ChatParams.EncryptionBackend instead.

EncryptionEnabled

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

Declaration
[Obsolete]
public bool EncryptionEnabled { get; set; }
Property Value
Type Description
System.Boolean

true if encryption is enabled, false otherwise

Remarks

Deprecated : 20/05/2024. Use Linphone.ChatParams.EncryptionEnabled() instead.

EphemeralLifetime

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.

Declaration
[Obsolete]
public int EphemeralLifetime { get; set; }
Property Value
Type Description
System.Int32

the ephemeral lifetime (in seconds)

Remarks

See : linphone_chat_room_params_ephemeral_enabled()

EphemeralMode

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

Declaration
[Obsolete]
public ChatRoomEphemeralMode EphemeralMode { get; set; }
Property Value
Type Description
ChatRoomEphemeralMode

the ephemeral message mode Linphone.ChatRoomEphemeralMode

Remarks

Deprecated : 20/05/2024. Use Linphone.ChatParams.EphemeralMode instead.

GroupEnabled

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

Declaration
[Obsolete]
public bool GroupEnabled { get; set; }
Property Value
Type Description
System.Boolean

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

Remarks

Deprecated : 20/05/2024. Use Linphone.ConferenceParams.GroupEnabled() instead.

IsValid

Returns whether the given parameters are valid or not.

Declaration
[Obsolete]
public bool IsValid { get; }
Property Value
Type Description
System.Boolean

true if the given parameters are valid, false otherwise

Remarks

Deprecated : 20/05/2024. Use Linphone.ConferenceParams.IsValid() instead.

RttEnabled

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

Declaration
[Obsolete]
public bool RttEnabled { get; set; }
Property Value
Type Description
System.Boolean

true if real time text is enabled, false otherwise

Remarks

Deprecated : 20/05/2024. Use Linphone.ChatParams.RttEnabled() instead.

Subject

Get the subject of the chat room.

Declaration
[Obsolete]
public string Subject { get; set; }
Property Value
Type Description
System.String

The subject. @maybenil

Remarks

Deprecated : 20/05/2024. Use Linphone.ConferenceParams.Subject instead.

In This Article
Back to top Generated by DocFX