Show / Hide Table of Contents

Class BaseAnnouncementsPreferences

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

Inheritance
object
BaseAnnouncementsPreferences
AnnouncementsPreferences
AnnouncementsPreferencesSummary
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.AnnouncementsService.Models
Assembly: OCI.DotNetSDK.Announcementsservice.dll
Syntax
[JsonConverter(typeof(BaseAnnouncementsPreferencesModelConverter))]
public class BaseAnnouncementsPreferences

Properties

CompartmentId

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

Id

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

The ID of the preferences.

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
[JsonProperty(PropertyName = "preferenceType")]
[JsonConverter(typeof(StringEnumConverter))]
public BaseCreateAnnouncementsPreferencesDetails.PreferenceTypeEnum? PreferenceType { get; set; }
Property Value
Type Description
BaseCreateAnnouncementsPreferencesDetails.PreferenceTypeEnum?

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

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

TimeCreated

Declaration
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

When the preferences were set initially.

TimeUpdated

Declaration
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }
Property Value
Type Description
DateTime?

When the preferences were last updated.

In this article
Back to top