@microsoft/app-manifest 1.0.0-alpha.06e5f8c8f.0

package/build/generated-types/teams/TeamsManifestV1D12.d.ts

@@ -0,0 +1,638 @@
+export interface TeamsManifestV1D12 {
+    $schema?: string;
+    /**
+     * The version of the schema this manifest is using.
+     */
+    manifestVersion: "1.12";
+    /**
+     * The version of the app. Changes to your manifest should cause a version change. This
+     * version string must follow the semver standard (http://semver.org).
+     */
+    version: string;
+    /**
+     * A unique identifier for this app. This id must be a GUID.
+     */
+    id: string;
+    /**
+     * A unique identifier for this app in reverse domain notation. E.g: com.example.myapp
+     */
+    packageName?: string;
+    localizationInfo?: LocalizationInfo;
+    developer: Developer;
+    name: Name;
+    description: Description;
+    icons: Icons;
+    /**
+     * A color to use in conjunction with the icon. The value must be a valid HTML color code
+     * starting with '#', for example `#4464ee`.
+     */
+    accentColor: string;
+    /**
+     * These are tabs users can optionally add to their channels and 1:1 or group chats and
+     * require extra configuration before they are added. Configurable tabs are not supported in
+     * the personal scope. Currently only one configurable tab per app is supported.
+     */
+    configurableTabs?: ConfigurableTab[];
+    /**
+     * A set of tabs that may be 'pinned' by default, without the user adding them manually.
+     * Static tabs declared in personal scope are always pinned to the app's personal
+     * experience. Static tabs do not currently support the 'teams' scope.
+     */
+    staticTabs?: StaticTab[];
+    /**
+     * The set of bots for this app. Currently only one bot per app is supported.
+     */
+    bots?: Bot[];
+    /**
+     * The set of Office365 connectors for this app. Currently only one connector per app is
+     * supported.
+     */
+    connectors?: Connector[];
+    /**
+     * Subscription offer associated with this app.
+     */
+    subscriptionOffer?: SubscriptionOffer;
+    /**
+     * The set of compose extensions for this app. Currently only one compose extension per app
+     * is supported.
+     */
+    composeExtensions?: ComposeExtension[];
+    /**
+     * Specifies the permissions the app requests from users.
+     */
+    permissions?: Permission[];
+    /**
+     * Specify the native features on a user's device that your app may request access to.
+     */
+    devicePermissions?: DevicePermission[];
+    /**
+     * A list of valid domains from which the tabs expect to load any content. Domain listings
+     * can include wildcards, for example `*.example.com`. If your tab configuration or content
+     * UI needs to navigate to any other domain besides the one use for tab configuration, that
+     * domain must be specified here.
+     */
+    validDomains?: string[];
+    /**
+     * Specify your AAD App ID and Graph information to help users seamlessly sign into your AAD
+     * app.
+     */
+    webApplicationInfo?: WebApplicationInfo;
+    /**
+     * Specify the app's Graph connector configuration. If this is present then
+     * webApplicationInfo.id must also be specified.
+     */
+    graphConnector?: GraphConnector;
+    /**
+     * A value indicating whether or not show loading indicator when app/tab is loading
+     */
+    showLoadingIndicator?: boolean;
+    /**
+     * A value indicating whether a personal app is rendered without a tab header-bar
+     */
+    isFullScreen?: boolean;
+    activities?: Activities;
+    /**
+     * A list of tenant configured properties for an app
+     */
+    configurableProperties?: ConfigurableProperty[];
+    /**
+     * A value indicating whether an app is blocked by default until admin allows it
+     */
+    defaultBlockUntilAdminAction?: boolean;
+    /**
+     * The url to the page that provides additional app information for the admins
+     */
+    publisherDocsUrl?: string;
+    /**
+     * The install scope defined for this app by default. This will be the option displayed on
+     * the button when a user tries to add the app
+     */
+    defaultInstallScope?: DefaultInstallScope;
+    /**
+     * When a group install scope is selected, this will define the default capability when the
+     * user installs the app
+     */
+    defaultGroupCapability?: DefaultGroupCapability;
+    /**
+     * Specify meeting extension definition.
+     */
+    meetingExtensionDefinition?: MeetingExtensionDefinition;
+    /**
+     * Specify and consolidates authorization related information for the App.
+     */
+    authorization?: Authorization;
+}
+export interface Activities {
+    /**
+     * Specify the types of activites that your app can post to a users activity feed
+     */
+    activityTypes?: ActivityType[];
+}
+export interface ActivityType {
+    type: string;
+    description: string;
+    templateText: string;
+}
+/**
+ * Specify and consolidates authorization related information for the App.
+ */
+export interface Authorization {
+    /**
+     * List of permissions that the app needs to function.
+     */
+    permissions?: Permissions;
+}
+/**
+ * List of permissions that the app needs to function.
+ */
+export interface Permissions {
+    /**
+     * Permissions that guard data access on a resource instance level.
+     */
+    resourceSpecific?: ResourceSpecific[];
+}
+export interface ResourceSpecific {
+    /**
+     * The name of the resource-specific permission.
+     */
+    name: string;
+    /**
+     * The type of the resource-specific permission.
+     */
+    type: ResourceSpecificType;
+}
+/**
+ * The type of the resource-specific permission.
+ */
+export type ResourceSpecificType = "Application" | "Delegated";
+export interface Bot {
+    /**
+     * The Microsoft App ID specified for the bot in the Bot Framework portal
+     * (https://dev.botframework.com/bots)
+     */
+    botId: string;
+    /**
+     * This value describes whether or not the bot utilizes a user hint to add the bot to a
+     * specific channel.
+     */
+    needsChannelSelector?: boolean;
+    /**
+     * A value indicating whether or not the bot is a one-way notification only bot, as opposed
+     * to a conversational bot.
+     */
+    isNotificationOnly?: boolean;
+    /**
+     * A value indicating whether the bot supports uploading/downloading of files.
+     */
+    supportsFiles?: boolean;
+    /**
+     * A value indicating whether the bot supports audio calling.
+     */
+    supportsCalling?: boolean;
+    /**
+     * A value indicating whether the bot supports video calling.
+     */
+    supportsVideo?: boolean;
+    /**
+     * Specifies whether the bot offers an experience in the context of a channel in a team, in
+     * a 1:1 or group chat, or in an experience scoped to an individual user alone. These
+     * options are non-exclusive.
+     */
+    scopes: CommandListScope[];
+    /**
+     * The list of commands that the bot supplies, including their usage, description, and the
+     * scope for which the commands are valid. A separate command list should be used for each
+     * scope.
+     */
+    commandLists?: CommandList[];
+}
+export interface CommandList {
+    /**
+     * Specifies the scopes for which the command list is valid
+     */
+    scopes: CommandListScope[];
+    commands: CommandListCommand[];
+}
+export interface CommandListCommand {
+    /**
+     * The bot command name
+     */
+    title: string;
+    /**
+     * A simple text description or an example of the command syntax and its arguments.
+     */
+    description: string;
+}
+export type CommandListScope = "team" | "personal" | "groupChat" | "groupchat";
+export interface ComposeExtension {
+    /**
+     * The Microsoft App ID specified for the bot powering the compose extension in the Bot
+     * Framework portal (https://dev.botframework.com/bots)
+     */
+    botId: string;
+    /**
+     * A value indicating whether the configuration of a compose extension can be updated by the
+     * user.
+     */
+    canUpdateConfiguration?: boolean;
+    commands: ComposeExtensionCommand[];
+    /**
+     * A list of handlers that allow apps to be invoked when certain conditions are met
+     */
+    messageHandlers?: MessageHandler[];
+}
+export interface ComposeExtensionCommand {
+    /**
+     * Id of the command.
+     */
+    id: string;
+    /**
+     * Type of the command
+     */
+    type?: CommandType;
+    /**
+     * Context where the command would apply
+     */
+    context?: CommandContext[];
+    /**
+     * Title of the command.
+     */
+    title: string;
+    /**
+     * Description of the command.
+     */
+    description?: string;
+    /**
+     * A boolean value that indicates if the command should be run once initially with no
+     * parameter.
+     */
+    initialRun?: boolean;
+    /**
+     * A boolean value that indicates if it should fetch task module dynamically
+     */
+    fetchTask?: boolean;
+    parameters?: Parameter[];
+    taskInfo?: TaskInfo;
+}
+export type CommandContext = "compose" | "commandBox" | "message";
+export interface Parameter {
+    /**
+     * Name of the parameter.
+     */
+    name: string;
+    /**
+     * Type of the parameter
+     */
+    inputType?: InputType;
+    /**
+     * Title of the parameter.
+     */
+    title: string;
+    /**
+     * Description of the parameter.
+     */
+    description?: string;
+    /**
+     * Initial value for the parameter
+     */
+    value?: string;
+    /**
+     * The choice options for the parameter
+     */
+    choices?: Choice[];
+}
+export interface Choice {
+    /**
+     * Title of the choice
+     */
+    title: string;
+    /**
+     * Value of the choice
+     */
+    value: string;
+}
+/**
+ * Type of the parameter
+ */
+export type InputType = "text" | "textarea" | "number" | "date" | "time" | "toggle" | "choiceset";
+export interface TaskInfo {
+    /**
+     * Initial dialog title
+     */
+    title?: string;
+    /**
+     * Dialog width - either a number in pixels or default layout such as 'large', 'medium', or
+     * 'small'
+     */
+    width?: string;
+    /**
+     * Dialog height - either a number in pixels or default layout such as 'large', 'medium', or
+     * 'small'
+     */
+    height?: string;
+    /**
+     * Initial webview URL
+     */
+    url?: string;
+}
+/**
+ * Type of the command
+ */
+export type CommandType = "query" | "action";
+export interface MessageHandler {
+    /**
+     * Type of the message handler
+     */
+    type: "link";
+    value: Value;
+}
+/**
+ * Type of the message handler
+ */
+export interface Value {
+    /**
+     * A list of domains that the link message handler can register for, and when they are
+     * matched the app will be invoked
+     */
+    domains?: string[];
+    [property: string]: any;
+}
+export type ConfigurableProperty = "name" | "shortDescription" | "longDescription" | "smallImageUrl" | "largeImageUrl" | "accentColor" | "developerUrl" | "privacyUrl" | "termsOfUseUrl";
+export interface ConfigurableTab {
+    /**
+     * The url to use when configuring the tab.
+     */
+    configurationUrl: string;
+    /**
+     * A value indicating whether an instance of the tab's configuration can be updated by the
+     * user after creation.
+     */
+    canUpdateConfiguration?: boolean;
+    /**
+     * Specifies whether the tab offers an experience in the context of a channel in a team, in
+     * a 1:1 or group chat, or in an experience scoped to an individual user alone. These
+     * options are non-exclusive. Currently, configurable tabs are only supported in the teams
+     * and groupchats scopes.
+     */
+    scopes: ConfigurableTabScope[];
+    /**
+     * The set of meetingSurfaceItem scopes that a tab belong to
+     */
+    meetingSurfaces?: MeetingSurface[];
+    /**
+     * The set of contextItem scopes that a tab belong to
+     */
+    context?: ConfigurableTabContext[];
+    /**
+     * A relative file path to a tab preview image for use in SharePoint. Size 1024x768.
+     */
+    sharePointPreviewImage?: string;
+    /**
+     * Defines how your tab will be made available in SharePoint.
+     */
+    supportedSharePointHosts?: SupportedSharePointHost[];
+}
+export type ConfigurableTabContext = "personalTab" | "channelTab" | "privateChatTab" | "meetingChatTab" | "meetingDetailsTab" | "meetingSidePanel" | "meetingStage" | "callingSidePanel";
+export type MeetingSurface = "sidePanel" | "stage";
+export type ConfigurableTabScope = "team" | "groupChat" | "groupchat";
+export type SupportedSharePointHost = "sharePointFullPage" | "sharePointWebPart";
+export interface Connector {
+    /**
+     * A unique identifier for the connector which matches its ID in the Connectors Developer
+     * Portal.
+     */
+    connectorId: string;
+    /**
+     * The url to use for configuring the connector using the inline configuration experience.
+     */
+    configurationUrl?: string;
+    /**
+     * Specifies whether the connector offers an experience in the context of a channel in a
+     * team, or an experience scoped to an individual user alone. Currently, only the team scope
+     * is supported.
+     */
+    scopes: "team"[];
+}
+/**
+ * When a group install scope is selected, this will define the default capability when the
+ * user installs the app
+ */
+export interface DefaultGroupCapability {
+    /**
+     * When the install scope selected is Team, this field specifies the default capability
+     * available
+     */
+    team?: Groupchat;
+    /**
+     * When the install scope selected is GroupChat, this field specifies the default capability
+     * available
+     */
+    groupchat?: Groupchat;
+    /**
+     * When the install scope selected is Meetings, this field specifies the default capability
+     * available
+     */
+    meetings?: Groupchat;
+}
+/**
+ * When the install scope selected is GroupChat, this field specifies the default capability
+ * available
+ *
+ * When the install scope selected is Meetings, this field specifies the default capability
+ * available
+ *
+ * When the install scope selected is Team, this field specifies the default capability
+ * available
+ */
+export type Groupchat = "tab" | "bot" | "connector";
+/**
+ * The install scope defined for this app by default. This will be the option displayed on
+ * the button when a user tries to add the app
+ */
+export type DefaultInstallScope = "personal" | "team" | "groupchat" | "groupChat" | "meetings";
+export interface Description {
+    /**
+     * A short description of the app used when space is limited. Maximum length is 80
+     * characters.
+     */
+    short: string;
+    /**
+     * The full description of the app. Maximum length is 4000 characters.
+     */
+    full: string;
+}
+export interface Developer {
+    /**
+     * The display name for the developer.
+     */
+    name: string;
+    /**
+     * The Microsoft Partner Network ID that identifies the partner organization building the
+     * app. This field is not required, and should only be used if you are already part of the
+     * Microsoft Partner Network. More info at https://aka.ms/partner
+     */
+    mpnId?: string;
+    /**
+     * The url to the page that provides support information for the app.
+     */
+    websiteUrl: string;
+    /**
+     * The url to the page that provides privacy information for the app.
+     */
+    privacyUrl: string;
+    /**
+     * The url to the page that provides the terms of use for the app.
+     */
+    termsOfUseUrl: string;
+}
+export type DevicePermission = "geolocation" | "media" | "notifications" | "midi" | "openExternal";
+/**
+ * Specify the app's Graph connector configuration. If this is present then
+ * webApplicationInfo.id must also be specified.
+ */
+export interface GraphConnector {
+    /**
+     * The url where Graph-connector notifications for the application should be sent.
+     */
+    notificationUrl: string;
+}
+export interface Icons {
+    /**
+     * A relative file path to a transparent PNG outline icon. The border color needs to be
+     * white. Size 32x32.
+     */
+    outline: string;
+    /**
+     * A relative file path to a full color PNG icon. Size 192x192.
+     */
+    color: string;
+}
+export interface LocalizationInfo {
+    /**
+     * The language tag of the strings in this top level manifest file.
+     */
+    defaultLanguageTag: string;
+    additionalLanguages?: AdditionalLanguage[];
+}
+export interface AdditionalLanguage {
+    /**
+     * The language tag of the strings in the provided file.
+     */
+    languageTag: string;
+    /**
+     * A relative file path to a the .json file containing the translated strings.
+     */
+    file: string;
+}
+/**
+ * Specify meeting extension definition.
+ */
+export interface MeetingExtensionDefinition {
+    /**
+     * Meeting supported scenes.
+     */
+    scenes?: Scene[];
+}
+export interface Scene {
+    /**
+     * A unique identifier for this scene. This id must be a GUID.
+     */
+    id: string;
+    /**
+     * Scene name.
+     */
+    name: string;
+    /**
+     * A relative file path to a scene metadata json file.
+     */
+    file: string;
+    /**
+     * A relative file path to a scene PNG preview icon.
+     */
+    preview: string;
+    /**
+     * Maximum audiences supported in scene.
+     */
+    maxAudience: number;
+    /**
+     * Number of seats reserved for organizers or presenters.
+     */
+    seatsReservedForOrganizersOrPresenters: number;
+}
+export interface Name {
+    /**
+     * A short display name for the app.
+     */
+    short: string;
+    /**
+     * The full name of the app, used if the full app name exceeds 30 characters.
+     */
+    full?: string;
+}
+export type Permission = "identity" | "messageTeamMembers";
+export interface StaticTab {
+    /**
+     * A unique identifier for the entity which the tab displays.
+     */
+    entityId: string;
+    /**
+     * The display name of the tab.
+     */
+    name?: string;
+    /**
+     * The url which points to the entity UI to be displayed in the Teams canvas.
+     */
+    contentUrl?: string;
+    /**
+     * The Microsoft App ID specified for the bot in the Bot Framework portal
+     * (https://dev.botframework.com/bots)
+     */
+    contentBotId?: string;
+    /**
+     * The url to point at if a user opts to view in a browser.
+     */
+    websiteUrl?: string;
+    /**
+     * The url to direct a user's search queries.
+     */
+    searchUrl?: string;
+    /**
+     * Specifies whether the tab offers an experience in the context of a channel in a team, or
+     * an experience scoped to an individual user alone. These options are non-exclusive.
+     * Currently static tabs are only supported in the 'personal' scope.
+     */
+    scopes: StaticTabScope[];
+    /**
+     * The set of contextItem scopes that a tab belong to
+     */
+    context?: StaticTabContext[];
+}
+export type StaticTabContext = "personalTab" | "channelTab";
+export type StaticTabScope = "team" | "personal";
+/**
+ * Subscription offer associated with this app.
+ */
+export interface SubscriptionOffer {
+    /**
+     * A unique identifier for the Commercial Marketplace Software as a Service Offer.
+     */
+    offerId: string;
+}
+/**
+ * Specify your AAD App ID and Graph information to help users seamlessly sign into your AAD
+ * app.
+ */
+export interface WebApplicationInfo {
+    /**
+     * AAD application id of the app. This id must be a GUID.
+     */
+    id: string;
+    /**
+     * Resource url of app for acquiring auth token for SSO.
+     */
+    resource?: string;
+}
+export declare class Convert {
+    static toTeamsManifestV1D12(json: string): TeamsManifestV1D12;
+    static teamsManifestV1D12ToJson(value: TeamsManifestV1D12): string;
+}