CallInfo interface

包:

@azure/communication-calling

有关呼叫的信息。

扩展

CallInfoCommon

属性

groupId	如果使用 CallAgent.join（groupLocator： GroupLocator） API 加入调用，请获取调用的组 ID。
roomId	如果使用 CallAgent.join（roomLocator： RoomLocator： RoomLocator） API 加入调用，请获取呼叫的会议室 ID。

继承属性

callScenario	获取呼叫的呼叫类型
context	获取有关调用的更多详细信息所需的附加信息上下文
direction	获取呼叫传出或传入的呼叫方向
initiatorKind	获取调用的发起程序类型
participantId	获取本地参与者 ID
targetKind	获取调用的发起方目标类型
threadId	获取团队会议 threadId ID。

继承的方法

getServerCallId()

获取服务器呼叫 ID。

属性详细信息

groupId

如果使用 CallAgent.join（groupLocator： GroupLocator） API 加入调用，请获取调用的组 ID。

groupId: undefined | string

属性值

undefined | string

roomId

注意

此 API 以 Beta 版本预览形式提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

如果使用 CallAgent.join（roomLocator： RoomLocator： RoomLocator） API 加入调用，请获取呼叫的会议室 ID。

roomId: undefined | string

属性值

undefined | string

继承属性详细信息

callScenario

注意

此 API 以 Beta 版本预览形式提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

获取呼叫的呼叫类型

callScenario?: CallInformationScenario

属性值

CallInformationScenario

继承自CallInfoCommon.callScenario

context

注意

此 API 以 Beta 版本预览形式提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

获取有关调用的更多详细信息所需的附加信息上下文

context?: CallInformationContext

属性值

CallInformationContext

继承自CallInfoCommon.context

direction

注意

此 API 以 Beta 版本预览形式提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

获取呼叫传出或传入的呼叫方向

direction?: CallDirection

属性值

CallDirection

继承自CallInfoCommon.direction

initiatorKind

注意

此 API 以 Beta 版本预览形式提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

获取调用的发起程序类型

initiatorKind?: CallInformationIdentifierKind

属性值

CallInformationIdentifierKind

继承自CallInfoCommon.initiatorKind

participantId

获取本地参与者 ID

participantId: string

属性值

string

继承自CallInfoCommon.participantId

targetKind

注意

此 API 以 Beta 版本预览形式提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

获取调用的发起方目标类型

targetKind?: string

属性值

string

继承自CallInfoCommon.targetKind

threadId

获取团队会议 threadId ID。

threadId: undefined | string

属性值

undefined | string

继承自CallInfoCommon.threadId 的

继承的方法详细信息

getServerCallId()

获取服务器呼叫 ID。

function getServerCallId(): Promise<string>

返回

Promise<string>

继承自CallInfoCommon.getServerCallId