- useConversation(session: undefined | Session, name: undefined | string, options?: GetOrCreateConversationOptions, join?: boolean, joinOptions?: JoinOptions): {
conversation: undefined | Conversation;
join: ((joinOptions?: JoinOptions) => Promise<void>);
joined: boolean;
joining: boolean;
leave: (() => Promise<void>);
}
-
Parameters
-
session: undefined | Session
-
name: undefined | string
-
Optional options: GetOrCreateConversationOptions
-
join: boolean = true
-
Optional joinOptions: JoinOptions
Returns {
conversation: undefined | Conversation;
join: ((joinOptions?: JoinOptions) => Promise<void>);
joined: boolean;
joining: boolean;
leave: (() => Promise<void>);
}
-
conversation: undefined | Conversation
-
join: ((joinOptions?: JoinOptions) => Promise<void>)
-
- (joinOptions?: JoinOptions): Promise<void>
-
Parameters
-
joinOptions: JoinOptions = {}
Returns Promise<void>
-
joined: boolean
-
joining: boolean
-
leave: (() => Promise<void>)
-
- (): Promise<void>
-
Returns Promise<void>
A hook to getOrCreate a named conversation and manage join/leave