Options
All
  • Public
  • Public/Protected
  • All
Menu

Module ListAnnouncementsRequest

Properties

Optional announcementType

announcementType: undefined | string

The type of announcement.

compartmentId

compartmentId: string

The OCID of the compartment. Because announcements are specific to a tenancy, this is the OCID of the root compartment.

Optional isBanner

isBanner: undefined | false | true

Whether the announcement is displayed as a console banner.

Optional lifecycleState

lifecycleState: LifecycleState

The announcement's current lifecycle state.

Optional limit

limit: undefined | number

The maximum number of items to return in a paginated "List" call.

Optional opcRequestId

opcRequestId: undefined | string

The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the complete request ID.

Optional page

page: undefined | string

The value of the opc-next-page response header from the previous "List" call.

Optional sortBy

sortBy: SortBy

The criteria to sort by. You can specify only one sort order.

Optional sortOrder

sortOrder: SortOrder

The sort order to use. (Sorting by announcementType orders the announcements list according to importance.)

Optional timeOneEarliestTime

timeOneEarliestTime: Date

The boundary for the earliest timeOneValue date on announcements that you want to see.

Optional timeOneLatestTime

timeOneLatestTime: Date

The boundary for the latest timeOneValue date on announcements that you want to see.