List of all members | Public Fields | Public Types | Public Instance Methods | Static Public Attributes
joinGroupCall Class Referencefinal

Inherits Function.

Description

Joins an active group call. Returns join response payload for tgcalls.

Returns object_ptr<Text>.

Public Fields

int32 group_call_id_
 Group call identifier.
 
object_ptr< MessageSenderparticipant_id_
 Identifier of a group call participant, which will be used to join the call; pass null to join as self; video chats only.
 
int32 audio_source_id_
 Caller audio channel synchronization source identifier; received from tgcalls.
 
string payload_
 Group call join payload; received from tgcalls.
 
bool is_muted_
 True, if the user's microphone is muted.
 
bool is_my_video_enabled_
 True, if the user's video is enabled.
 
string invite_hash_
 If non-empty, invite hash to be used to join the group call without being muted by administrators.
 

Public Types

using ReturnType = object_ptr< text >
 Typedef for the type returned by the function.
 

Public Instance Methods

 joinGroupCall ()
 
 joinGroupCall (int32 group_call_id_, object_ptr< MessageSender > &&participant_id_, int32 audio_source_id_, string const &payload_, bool is_muted_, bool is_my_video_enabled_, string const &invite_hash_)
 
std::int32_t get_id () const final
 
void store (TlStorerToString &s, const char *field_name) const final
 
- Public Instance Methods inherited from TlObject
virtual void store (TlStorerUnsafe &s) const
 
virtual void store (TlStorerCalcLength &s) const
 
 TlObject ()=default
 
 TlObject (const TlObject &)=delete
 
TlObjectoperator= (const TlObject &)=delete
 
 TlObject (TlObject &&)=default
 
TlObjectoperator= (TlObject &&)=default
 
virtual ~TlObject ()=default
 

Static Public Attributes

static const std::int32_t ID = -1043773467
 Identifier uniquely determining a type of the object.
 

Constructor & Destructor Documentation

◆ joinGroupCall() [1/2]

Default constructor for a function, which joins an active group call. Returns join response payload for tgcalls.

Returns object_ptr<Text>.

◆ joinGroupCall() [2/2]

joinGroupCall ( int32  group_call_id_,
object_ptr< MessageSender > &&  participant_id_,
int32  audio_source_id_,
string const &  payload_,
bool  is_muted_,
bool  is_my_video_enabled_,
string const &  invite_hash_ 
)

Creates a function, which joins an active group call. Returns join response payload for tgcalls.

Returns object_ptr<Text>.

Parameters
[in]group_call_id_Group call identifier.
[in]participant_id_Identifier of a group call participant, which will be used to join the call; pass null to join as self; video chats only.
[in]audio_source_id_Caller audio channel synchronization source identifier; received from tgcalls.
[in]payload_Group call join payload; received from tgcalls.
[in]is_muted_True, if the user's microphone is muted.
[in]is_my_video_enabled_True, if the user's video is enabled.
[in]invite_hash_If non-empty, invite hash to be used to join the group call without being muted by administrators.

Method Documentation

◆ get_id()

std::int32_t get_id ( ) const
inlinefinalvirtual

Returns identifier uniquely determining a type of the object.

Returns
this->ID.

Implements TlObject.

◆ store()

void store ( TlStorerToString &  s,
const char *  field_name 
) const
finalvirtual

Helper function for to_string method. Appends string representation of the object to the storer.

Parameters
[in]sStorer to which object string representation will be appended.
[in]field_nameObject field_name if applicable.

Implements TlObject.


The documentation for this class was generated from the following file: