Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace BaseCreateAnnouncementsPreferencesDetails

The model for the parameters of announcement email preferences configured for the tenancy (root compartment).

Properties

Optional compartmentId

compartmentId: undefined | string

The OCID of the compartment for which you want to manage announcement email preferences. (Specify the tenancy by providing the root compartment OCID.)

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.)

preferenceType

preferenceType: PreferenceType

The string representing the user's preference, whether to opt in to only required announcements, to opt in to all announcements, including informational announcements, or to opt out of all announcements.

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

type

type: string

Functions

getDeserializedJsonObj

getJsonObj