Share via

AppId class

  • Reference
Package:
@microsoft/teams-js

A strongly-typed class used to represent a "valid" app id.

Valid is a relative term, in this case. Truly valid app ids are UUIDs as documented in the schema: https://learn.microsoft.com/en-us/microsoftteams/platform/resources/schema/manifest-schema#id However, there are some older internal/hard-coded apps which violate this schema and use names like com.microsoft.teamspace.tab.youtube. For compatibility with these legacy apps, we unfortunately cannot securely and completely validate app ids as UUIDs. Based on this, the validation is limited to checking for script tags, length, and non-printable characters. Validation will be updated in the future to ensure the app id is a valid UUID as legacy apps update.

Extends
ValidatedSafeString

Constructors

AppId(string)

Creates a strongly-typed AppId from a string

Methods

toJSON()

Returns a JSON representation of the AppId object

Inherited Methods

toString()

Returns the app id as a string

Constructor Details

AppId(string)

Creates a strongly-typed AppId from a string

new AppId(appIdAsString: string)

Parameters

appIdAsString

string

An app id represented as a string

Method Details

toJSON()

Returns a JSON representation of the AppId object

function toJSON(): object

Returns

object

A JSON representation of the AppId object

note: this method maintains backward compatibility for JSON serialization

Inherited Method Details

toString()

Returns the app id as a string

function toString(): string

Returns

string

Inherited From ValidatedSafeString.toString