Edit

Share via

ConversationAccount interface

  • Reference
Package:
botframework-schema

Channel account information for a conversation

Properties

aadObjectId

This account's object ID within Azure Active Directory (AAD)
conversationType

Indicates the type of the conversation in channels that distinguish between conversation types
id

Channel id for the user or bot on this channel (Example: [email protected], or @joesmith or 123456)
isGroup

Indicates whether the conversation contains more than two participants at the time the activity was generated
name

Display friendly name
properties

Custom properties object (optional)
role

Role of the entity behind the account (Example: User, Bot, etc.). Possible values include: 'user', 'bot'
tenantId

This conversation's tenant ID

Property Details

aadObjectId

This account's object ID within Azure Active Directory (AAD)

aadObjectId?: string

Property Value

string

conversationType

Indicates the type of the conversation in channels that distinguish between conversation types

conversationType: string

Property Value

string

id

Channel id for the user or bot on this channel (Example: [email protected], or @joesmith or 123456)

id: string

Property Value

string

isGroup

Indicates whether the conversation contains more than two participants at the time the activity was generated

isGroup: boolean

Property Value

boolean

name

Display friendly name

name: string

Property Value

string

properties

Custom properties object (optional)

properties?: any

Property Value

any

role

Role of the entity behind the account (Example: User, Bot, etc.). Possible values include: 'user', 'bot'

role?: RoleTypes

Property Value

RoleTypes

tenantId

This conversation's tenant ID

tenantId?: string

Property Value

string