Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AnnouncementsPreferencesClient

Hierarchy

  • AnnouncementsPreferencesClient

Constructors

constructor

Properties

Protected _circuitBreaker

_circuitBreaker: null = null

Protected _clientConfiguration

_clientConfiguration: ClientConfiguration

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://announcements.{region}.{secondLevelDomain}"

Accessors

endpoint

  • get endpoint(): string
  • set endpoint(endpoint: string): void

logger

region

  • set region(region: Region): void
  • Sets the region to call (ex, Region.US_PHOENIX_1). Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.

    Parameters

    • region: Region

      The region of the service.

    Returns void

regionId

  • set regionId(regionId: string): void
  • Sets the regionId to call (ex, 'us-phoenix-1').

    Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.

    Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.

    Parameters

    • regionId: string

      The public region ID.

    Returns void

Methods

createAnnouncementsPreference

getAnnouncementsPreference

listAllAnnouncementsPreferences

listAllAnnouncementsPreferencesResponses

listAnnouncementsPreferences

updateAnnouncementsPreference