Class BaseCreateAnnouncementsPreferencesDetails

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

Inheritance
object
BaseCreateAnnouncementsPreferencesDetails
CreateAnnouncementsPreferencesDetails
UpdateAnnouncementsPreferencesDetails
Inherited Members
Namespace: Oci.AnnouncementsService.Models
Assembly: OCI.DotNetSDK.Announcementsservice.dll
Syntax
[JsonConverter(typeof(BaseCreateAnnouncementsPreferencesDetailsModelConverter))]
public class BaseCreateAnnouncementsPreferencesDetails

Properties

CompartmentId

Declaration
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

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

IsUnsubscribed

Declaration
[JsonProperty(PropertyName = "isUnsubscribed")]
public bool? IsUnsubscribed { get; set; }
Property Value
Type Description
bool?

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 preferenceType attribute instead.)

PreferenceType

Declaration
[Required(ErrorMessage = "PreferenceType is required.")]
[JsonProperty(PropertyName = "preferenceType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public BaseCreateAnnouncementsPreferencesDetails.PreferenceTypeEnum? PreferenceType { get; set; }
Property Value
Type Description
BaseCreateAnnouncementsPreferencesDetails.PreferenceTypeEnum?

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

Required

PreferredTimeZone

Declaration
[JsonProperty(PropertyName = "preferredTimeZone")]
public string PreferredTimeZone { get; set; }
Property Value
Type Description
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