Documentation - v1.2.0-alpha.3
    Preparing search index...

    Represents a Teams client citation to be included in a message.

    interface ClientCitation {
        "@type": "Claim";
        appearance: {
            "@type": "DigitalDocument";
            abstract: string;
            encodingFormat?: "application/vnd.microsoft.card.adaptive";
            image?: { "@type": "ImageObject"; name: ClientCitationIconName };
            keywords?: string[];
            name: string;
            text?: string;
            url?: string;
            usageInfo?: SensitivityUsageInfo;
        };
        position: number;
    }
    Index

    Properties

    "@type": "Claim"

    Required; must be "Claim"

    appearance: {
        "@type": "DigitalDocument";
        abstract: string;
        encodingFormat?: "application/vnd.microsoft.card.adaptive";
        image?: { "@type": "ImageObject"; name: ClientCitationIconName };
        keywords?: string[];
        name: string;
        text?: string;
        url?: string;
        usageInfo?: SensitivityUsageInfo;
    }

    Optional; if provided, the citation will be displayed in the message.

    Type Declaration

    • @type: "DigitalDocument"

      Required; Must be 'DigitalDocument'

    • abstract: string

      Extract of the referenced content. (max length 160)

    • OptionalencodingFormat?: "application/vnd.microsoft.card.adaptive"

      Encoding format of the citation.appearance.text field.

    • Optionalimage?: { "@type": "ImageObject"; name: ClientCitationIconName }

      Information about the citation’s icon.

    • Optionalkeywords?: string[]

      Optional; set by developer. (max length 3) (max keyword length 28)

    • name: string

      Name of the document. (max length 80)

    • Optionaltext?: string

      Stringified adaptive card with additional information about the citation. It is rendered within the modal.

    • Optionalurl?: string

      URL of the document. This will make the name of the citation clickable and direct the user to the specified URL.

    • OptionalusageInfo?: SensitivityUsageInfo

      Optional sensitivity content information.

    position: number

    Required. Number and position of the citation.