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

    Interface SensitivityUsageInfo

    Sensitivity usage info for content sent to the user.

    This is used to provide information about the content to the user. See ClientCitation for more information.

    interface SensitivityUsageInfo {
        "@type": "CreativeWork";
        description?: string;
        name: string;
        pattern?: {
            "@type": "DefinedTerm";
            inDefinedTermSet: string;
            name: string;
            termCode: string;
        };
        position?: number;
        type: "https://schema.org/Message";
    }
    Index

    Properties

    @type description? name pattern? position? type

    Properties

    "@type": "CreativeWork"

    Required; Set to CreativeWork;

    description?: string

    Sensitivity description of the content

    name: string

    Sensitivity title of the content

    pattern?: {
        "@type": "DefinedTerm";
        inDefinedTermSet: string;
        name: string;
        termCode: string;
    }

    Optional; if provided, the content is considered sensitive and should be handled accordingly.

    Type Declaration

    • @type: "DefinedTerm"

      Set to DefinedTerm

    • inDefinedTermSet: string
    • name: string

      Color

    • termCode: string

      e.g. #454545

    position?: number

    Optional; ignored in Teams.

    type: "https://schema.org/Message"

    Must be "https://schema.org/Message"

    Settings

    Member Visibility

    On This Page

    Properties