AnnouncementsPreferences¶

class oci.announcements_service.models.AnnouncementsPreferences(**kwargs)¶

Bases: oci.announcements_service.models.base_announcements_preferences.BaseAnnouncementsPreferences

The object for announcement email preferences.

Methods

`__init__`(**kwargs)	Initializes a new AnnouncementsPreferences object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

Attributes

`compartment_id`	Gets the compartment_id of this BaseAnnouncementsPreferences.
`id`	Gets the id of this BaseAnnouncementsPreferences.
`is_unsubscribed`	Gets the is_unsubscribed of this BaseAnnouncementsPreferences.
`preference_type`	Gets the preference_type of this BaseAnnouncementsPreferences.
`preferred_time_zone`	Gets the preferred_time_zone of this BaseAnnouncementsPreferences.
`time_created`	Gets the time_created of this BaseAnnouncementsPreferences.
`time_updated`	Gets the time_updated of this BaseAnnouncementsPreferences.
`type`	[Required] Gets the type of this BaseAnnouncementsPreferences.

__init__(**kwargs)¶

Initializes a new AnnouncementsPreferences object with values from keyword arguments. The default value of the type attribute of this class is AnnouncementsPreferences and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

type (str) – The value to assign to the type property of this AnnouncementsPreferences.
compartment_id (str) – The value to assign to the compartment_id property of this AnnouncementsPreferences.
id (str) – The value to assign to the id property of this AnnouncementsPreferences.
is_unsubscribed (bool) – The value to assign to the is_unsubscribed property of this AnnouncementsPreferences.
time_created (datetime) – The value to assign to the time_created property of this AnnouncementsPreferences.
time_updated (datetime) – The value to assign to the time_updated property of this AnnouncementsPreferences.
preference_type (str) – The value to assign to the preference_type property of this AnnouncementsPreferences.
preferred_time_zone (str) – The value to assign to the preferred_time_zone property of this AnnouncementsPreferences.

compartment_id¶

Gets the compartment_id of this BaseAnnouncementsPreferences. 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.

Returns:	The compartment_id of this BaseAnnouncementsPreferences.
Return type:	str

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

id¶

Gets the id of this BaseAnnouncementsPreferences. The ID of the preferences.

Returns:	The id of this BaseAnnouncementsPreferences.
Return type:	str

is_unsubscribed¶

Gets the is_unsubscribed of this BaseAnnouncementsPreferences. 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.)

Returns:	The is_unsubscribed of this BaseAnnouncementsPreferences.
Return type:	bool

preference_type¶

Gets the preference_type of this BaseAnnouncementsPreferences. The string representing the user’s preference regarding receiving announcements by email.

Returns:	The preference_type of this BaseAnnouncementsPreferences.
Return type:	str

preferred_time_zone¶

Gets the preferred_time_zone of this BaseAnnouncementsPreferences. 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

Returns:	The preferred_time_zone of this BaseAnnouncementsPreferences.
Return type:	str

time_created¶

Gets the time_created of this BaseAnnouncementsPreferences. When the preferences were set initially.

Returns:	The time_created of this BaseAnnouncementsPreferences.
Return type:	datetime

time_updated¶

Gets the time_updated of this BaseAnnouncementsPreferences. When the preferences were last updated.

Returns:	The time_updated of this BaseAnnouncementsPreferences.
Return type:	datetime

type¶

[Required] Gets the type of this BaseAnnouncementsPreferences. The entity type, which specifies either an object or a summary object for announcement email preferences.

Returns:	The type of this BaseAnnouncementsPreferences.
Return type:	str