Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace BaseAnnouncementsPreferences

The object that contains the announcement email preferences configured for the tenancy (root compartment).

Properties

Optional compartmentId

compartmentId: undefined | string

The OCID of the compartment for which the email preferences apply. Because announcements are specific to a tenancy, specify the tenancy by providing the root compartment OCID.

Optional id

id: undefined | string

The ID of the preferences.

Optional isUnsubscribed

isUnsubscribed: undefined | false | true

A Boolean value to indicate whether the specified compartment chooses to not to receive informational announcements by email. (Manage preferences for receiving announcements by email by specifying the {@code preferenceType} attribute instead.)

Optional preferenceType

preferenceType: undefined | string

The string representing the user's preference regarding receiving announcements by email.

Optional preferredTimeZone

preferredTimeZone: undefined | string

The time zone in which the user prefers to receive announcements. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles

Optional timeCreated

timeCreated: Date

When the preferences were set initially.

Optional timeUpdated

timeUpdated: Date

When the preferences were last updated.

type

type: string

Functions

getDeserializedJsonObj

getJsonObj