Utility class

Pakket:
@microsoft/agents-a365-runtime

Hulpprogrammaklasse die helpermethoden biedt voor agentruntimebewerkingen.

Methoden

getAgentIdFromToken(string)

WAARSCHUWING: GEEN HANDTEKENINGVERIFICATIE: deze methode maakt gebruik van jwt.decode() die de tokenhandtekening NIET verifieert. De tokenclaims kunnen worden vervalst door kwaadwillende actoren. Deze methode is ALLEEN geschikt voor logboekregistratie, analyse en diagnostische doeleinden. Gebruik niet de geretourneerde waarde voor autorisatie, toegangsbeheer of beveiligingsbeslissingen.

Ontsleutelt het token en haalt de beste beschikbare agent-id op. Controleert claims in prioriteitsvolgorde: xms_par_app_azp (blauwdruk-id van agent) > appid > azp.

Opmerking: retourneert een lege tekenreeks voor lege/ontbrekende tokens (in tegenstelling tot GetAppIdFromToken die een standaard-GUID retourneert). Hierdoor kunnen bellers headers weglaten wanneer er geen id beschikbaar is.
GetAppIdFromToken(string)

WAARSCHUWING: GEEN HANDTEKENINGVERIFICATIE: deze methode maakt gebruik van jwt.decode() die de tokenhandtekening NIET verifieert. De tokenclaims kunnen worden vervalst door kwaadwillende actoren. Deze methode is ALLEEN geschikt voor logboekregistratie, analyse en diagnostische doeleinden. Gebruik niet de geretourneerde waarde voor autorisatie, toegangsbeheer of beveiligingsbeslissingen.

Decodeert het huidige token en haalt de app-id (appid of azp-claim) op.

Opmerking: retourneert een standaard-GUID ('00000000-0000-0000-00000000000000') voor lege tokens voor achterwaartse compatibiliteit met bellers die een geldig uitziende GUID verwachten. Gebruik getAgentIdFromToken voor agentidentificatie waarbij een lege tekenreeks de voorkeur heeft.
getApplicationName()

Hiermee haalt u de naam van de toepassing op uit npm_package_name omgevingsvariabele of package.json. Het package.json resultaat wordt opgeslagen in de cache tijdens de laadtijd van de module om synchronisatie-I/O tijdens aanvragen te voorkomen.
GetUserAgentHeader(string)

Hiermee genereert u een User-Agent headertekenreeks met SDK-versie, besturingssysteemtype, Node.js versie en orchestrator.
ResolveAgentIdentity(TurnContext, string)

Hiermee wordt de agentidentiteit omgezet vanuit de context van de beurt of het verificatietoken.

Methodedetails

getAgentIdFromToken(string)

WAARSCHUWING: GEEN HANDTEKENINGVERIFICATIE: deze methode maakt gebruik van jwt.decode() die de tokenhandtekening NIET verifieert. De tokenclaims kunnen worden vervalst door kwaadwillende actoren. Deze methode is ALLEEN geschikt voor logboekregistratie, analyse en diagnostische doeleinden. Gebruik niet de geretourneerde waarde voor autorisatie, toegangsbeheer of beveiligingsbeslissingen.

Ontsleutelt het token en haalt de beste beschikbare agent-id op. Controleert claims in prioriteitsvolgorde: xms_par_app_azp (blauwdruk-id van agent) > appid > azp.

Opmerking: retourneert een lege tekenreeks voor lege/ontbrekende tokens (in tegenstelling tot GetAppIdFromToken die een standaard-GUID retourneert). Hierdoor kunnen bellers headers weglaten wanneer er geen id beschikbaar is.

static function getAgentIdFromToken(token: string): string

Parameters

token

string

JWT-token om te decoderen

Retouren

string

Agent-id (GUID) of lege tekenreeks als deze niet is gevonden of als het token leeg is

GetAppIdFromToken(string)

WAARSCHUWING: GEEN HANDTEKENINGVERIFICATIE: deze methode maakt gebruik van jwt.decode() die de tokenhandtekening NIET verifieert. De tokenclaims kunnen worden vervalst door kwaadwillende actoren. Deze methode is ALLEEN geschikt voor logboekregistratie, analyse en diagnostische doeleinden. Gebruik niet de geretourneerde waarde voor autorisatie, toegangsbeheer of beveiligingsbeslissingen.

Decodeert het huidige token en haalt de app-id (appid of azp-claim) op.

Opmerking: retourneert een standaard-GUID ('00000000-0000-0000-00000000000000') voor lege tokens voor achterwaartse compatibiliteit met bellers die een geldig uitziende GUID verwachten. Gebruik getAgentIdFromToken voor agentidentificatie waarbij een lege tekenreeks de voorkeur heeft.

static function GetAppIdFromToken(token: string): string

Parameters

token

string

Token om te decoderen

Retouren

string

AppId of standaard-GUID voor een leeg token of een lege tekenreeks als decoderen mislukt

getApplicationName()

Hiermee haalt u de naam van de toepassing op uit npm_package_name omgevingsvariabele of package.json. Het package.json resultaat wordt opgeslagen in de cache tijdens de laadtijd van de module om synchronisatie-I/O tijdens aanvragen te voorkomen.

static function getApplicationName(): undefined | string

Retouren

undefined | string

Toepassingsnaam of niet gedefinieerd als deze niet beschikbaar is.

GetUserAgentHeader(string)

Hiermee genereert u een User-Agent headertekenreeks met SDK-versie, besturingssysteemtype, Node.js versie en orchestrator.

static function GetUserAgentHeader(orchestrator?: string): string

Parameters

orchestrator

string

Optionele orchestrator-id die moet worden opgenomen in de User-Agent tekenreeks.

Retouren

string

Opgemaakte User-Agent kopteksttekenreeks.

ResolveAgentIdentity(TurnContext, string)

Hiermee wordt de agentidentiteit omgezet vanuit de context van de beurt of het verificatietoken.

static function ResolveAgentIdentity(context: TurnContext, authToken: string): string

Parameters

context
TurnContext

De context van de draai draaien.

authToken

string

Verificatietoken indien beschikbaar.

Retouren

string

Agentidentiteit (app-id)