ConversationMemberClient Class

Client for managing members in a Teams conversation.

Initialize the conversation member client.

Constructor

ConversationMemberClient(service_url: str, http_client: Client | None = None, api_client_settings: ApiClientSettings | None = None)

Parameters

Name	Description
service_url Required	The base URL for the Teams service
http_client	Optional HTTP client to use. If not provided, a new one will be created. Default value: None
api_client_settings	Optional API client settings. Default value: None

Methods

get	Get all members in a conversation.
get_by_id	Get a specific member in a conversation.
get_paged	Get a page of members in a conversation.

get

Get all members in a conversation.

async get(conversation_id: str) -> List[TeamsChannelAccount]

Parameters

Name	Description
conversation_id Required	The ID of the conversation

Returns

Type	Description
	List of TeamsChannelAccount objects representing the conversation members

get_by_id

Get a specific member in a conversation.

async get_by_id(conversation_id: str, member_id: str) -> TeamsChannelAccount

Parameters

Name	Description
conversation_id Required	The ID of the conversation
member_id Required	The ID of the member to get

Returns

Type	Description
	TeamsChannelAccount object representing the conversation member

get_paged

Get a page of members in a conversation.

async get_paged(conversation_id: str, page_size: int | None = None, continuation_token: str | None = None) -> PagedMembersResult

Parameters

Name	Description
conversation_id Required	The ID of the conversation.
page_size	Optional maximum number of members to return per page. Default value: None
continuation_token	Optional token from a previous call to fetch the next page. Default value: None

Returns

Type	Description
	PagedMembersResult containing the members and an optional continuation token for fetching subsequent pages.