Interface ContactOption

Represents a contact option.

interface ContactOption {
    about?: string;
    channels?: Channel[];
    configCategory?: "CONTACTOPTIES";
    createdAt?: string;
    groupDisplayLabel?: string;
    key: string;
    label: string;
    lastModifiedAt?: string;
    name: string;
    ouapi_id?: string;
    privacy?: ContactPrivacy;
    requestedBy?: string;
    social?: {
        description?: string;
        media?: {
            description?: string;
            icon: ContactOptionSocialPlatform;
            text?: string;
            url: string;
        }[];
    };
    subject?: string;
    [key: string]: unknown;
}

Hierarchy

  • Record<string, unknown>
    • ContactOption

Indexable

  • [key: string]: unknown

Properties

about? channels? configCategory? createdAt? groupDisplayLabel? key label lastModifiedAt? name ouapi_id? privacy? requestedBy? social? subject?

Properties

Optionalabout

about?: string

Optional description or information about the contact option.

Optionalchannels

channels?: Channel[]

Channels associated with the contact option.

OptionalconfigCategory

configCategory?: "CONTACTOPTIES"

The category for this configuration.

OptionalcreatedAt

createdAt?: string

Timestamp of when the contact option was created.

OptionalgroupDisplayLabel

groupDisplayLabel?: string

The label for the contact option in the group.

key

key: string

The key associated with the contact option.

label

label: string

The label for the contact option.

OptionallastModifiedAt

lastModifiedAt?: string

Timestamp of when the contact option was last modified.

name

name: string

The name of the contact option.

Optionalouapi_id

ouapi_id?: string

Optional ID for API purposes.

Optionalprivacy

privacy?: ContactPrivacy

Privacy settings related to the contact option.

OptionalrequestedBy

requestedBy?: string

Person or entity requesting the contact option.

Optionalsocial

social?: {
    description?: string;
    media?: {
        description?: string;
        icon: ContactOptionSocialPlatform;
        text?: string;
        url: string;
    }[];
}

Social media links related to this contact option.

Type declaration

  • Optionaldescription?: string

    Optional description of the social media section.

  • Optionalmedia?: {
        description?: string;
        icon: ContactOptionSocialPlatform;
        text?: string;
        url: string;
    }[]

    Array of social media links.

Optionalsubject

subject?: string

Subject of the contact option.

Settings

Member Visibility

On This Page

Properties