ChannelAdapterProtocol Class

Constructor

ChannelAdapterProtocol()

Methods

__init__
__new__
continue_conversation
continue_conversation_with_claims
create_conversation
delete_activity
run_pipeline
send_activities
update_activity
use

__init__

__init__(*args, **kwargs)

__new__

__new__(**kwargs)

continue_conversation

abstract async continue_conversation(agent_id: str, reference: ConversationReference, callback: Callable[[TurnContextProtocol], Awaitable]) -> None

Parameters

Name	Description
agent_id Required	str
reference Required	ConversationReference
callback Required	Callable[[TurnContextProtocol], Awaitable]

Returns

Type	Description
None

continue_conversation_with_claims

abstract async continue_conversation_with_claims(claims_identity: dict, continuation_activity: Activity, callback: Callable[[TurnContextProtocol], Awaitable], audience: str = None)

Parameters

Name	Description
claims_identity Required	dict
continuation_activity Required	Activity
callback Required	Callable[[TurnContextProtocol], Awaitable]
audience	str Default value: None

create_conversation

abstract async create_conversation(agent_app_id: str, channel_id: str, service_url: str, audience: str, conversation_parameters: ConversationParameters, callback: Callable[[TurnContextProtocol], Awaitable]) -> None

Parameters

Name	Description
agent_app_id Required	str
channel_id Required	str
service_url Required	str
audience Required	str
conversation_parameters Required	ConversationParameters
callback Required	Callable[[TurnContextProtocol], Awaitable]

Returns

Type	Description
None

delete_activity

abstract async delete_activity(context: TurnContextProtocol, reference: ConversationReference) -> None

Parameters

Name	Description
context Required	TurnContextProtocol
reference Required	ConversationReference

Returns

Type	Description
None

run_pipeline

abstract async run_pipeline(context: TurnContextProtocol, callback: Callable[[TurnContextProtocol], Awaitable]) -> None

Parameters

Name	Description
context Required	TurnContextProtocol
callback Required	Callable[[TurnContextProtocol], Awaitable]

Returns

Type	Description
None

send_activities

abstract async send_activities(context: TurnContextProtocol, activities: List[Activity]) -> List[ResourceResponse]

Parameters

Name	Description
context Required	TurnContextProtocol
activities Required	List[Activity]

Returns

Type	Description
List[ResourceResponse]

update_activity

abstract async update_activity(context: TurnContextProtocol, activity: Activity) -> None

Parameters

Name	Description
context Required	TurnContextProtocol
activity Required	Activity

Returns

Type	Description
None

use

abstract use(middleware: object) -> ChannelAdapterProtocol

Parameters

Name	Description
middleware Required	object

Returns

Type	Description
ChannelAdapterProtocol

Attributes

on_turn_error

on_turn_error: Callable[[TurnContextProtocol, Exception], Awaitable] | None