pushservicev1

package
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 19, 2021 License: Apache-2.0 Imports: 10 Imported by: 2

Documentation

Overview

Package pushservicev1 : Operations and models for the PushServiceV1 service

Index

Constants

View Source 
const (
	Apns_Type_Default = "DEFAULT"
	Apns_Type_Mixed   = "MIXED"
	Apns_Type_Silent  = "SILENT"
)

Constants associated with the Apns.Type property.

View Source 
const (
	Gcm_Type_Default = "DEFAULT"
	Gcm_Type_Silent  = "SILENT"
)

Constants associated with the Gcm.Type property.

View Source 
const DefaultServiceName = "push_service"

DefaultServiceName is the default key used to find external configuration information.

View Source 
const DefaultServiceURL = "https://push-service.cloud.ibm.com/imfpush/v1"

DefaultServiceURL is the default URL to make service requests to.

Variables

This section is empty.

Functions

func GetServiceURLForRegion 

func GetServiceURLForRegion(region string) (string, error)

GetServiceURLForRegion returns the service URL to be used for the specified region

func UnmarshalApns 

func UnmarshalApns(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalApns unmarshals an instance of Apns from the specified map of raw messages.

func UnmarshalApnsCertUploadResponse 

func UnmarshalApnsCertUploadResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalApnsCertUploadResponse unmarshals an instance of ApnsCertUploadResponse from the specified map of raw messages.

func UnmarshalAppSettingsObjResponse 

func UnmarshalAppSettingsObjResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAppSettingsObjResponse unmarshals an instance of AppSettingsObjResponse from the specified map of raw messages.

func UnmarshalApplicationServerKeyModel 

func UnmarshalApplicationServerKeyModel(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalApplicationServerKeyModel unmarshals an instance of ApplicationServerKeyModel from the specified map of raw messages.

func UnmarshalChromeAppExt 

func UnmarshalChromeAppExt(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalChromeAppExt unmarshals an instance of ChromeAppExt from the specified map of raw messages.

func UnmarshalChromeWeb 

func UnmarshalChromeWeb(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalChromeWeb unmarshals an instance of ChromeWeb from the specified map of raw messages.

func UnmarshalChromeWebPushCredendialsModel 

func UnmarshalChromeWebPushCredendialsModel(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalChromeWebPushCredendialsModel unmarshals an instance of ChromeWebPushCredendialsModel from the specified map of raw messages.

func UnmarshalFirefoxWeb 

func UnmarshalFirefoxWeb(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalFirefoxWeb unmarshals an instance of FirefoxWeb from the specified map of raw messages.

func UnmarshalFirefoxWebPushCredendialsModel 

func UnmarshalFirefoxWebPushCredendialsModel(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalFirefoxWebPushCredendialsModel unmarshals an instance of FirefoxWebPushCredendialsModel from the specified map of raw messages.

func UnmarshalGCMCredendialsModel 

func UnmarshalGCMCredendialsModel(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGCMCredendialsModel unmarshals an instance of GCMCredendialsModel from the specified map of raw messages.

func UnmarshalGCMCredendialsPublicModel 

func UnmarshalGCMCredendialsPublicModel(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGCMCredendialsPublicModel unmarshals an instance of GCMCredendialsPublicModel from the specified map of raw messages.

func UnmarshalGcm 

func UnmarshalGcm(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGcm unmarshals an instance of Gcm from the specified map of raw messages.

func UnmarshalLights 

func UnmarshalLights(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalLights unmarshals an instance of Lights from the specified map of raw messages.

func UnmarshalMessage 

func UnmarshalMessage(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalMessage unmarshals an instance of Message from the specified map of raw messages.

func UnmarshalMessageResponseModel 

func UnmarshalMessageResponseModel(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalMessageResponseModel unmarshals an instance of MessageResponseModel from the specified map of raw messages.

func UnmarshalMessagesArrayModel 

func UnmarshalMessagesArrayModel(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalMessagesArrayModel unmarshals an instance of MessagesArrayModel from the specified map of raw messages.

func UnmarshalMessagesList 

func UnmarshalMessagesList(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalMessagesList unmarshals an instance of MessagesList from the specified map of raw messages.

func UnmarshalSafariCertUploadResponse 

func UnmarshalSafariCertUploadResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSafariCertUploadResponse unmarshals an instance of SafariCertUploadResponse from the specified map of raw messages.

func UnmarshalSafariWeb 

func UnmarshalSafariWeb(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSafariWeb unmarshals an instance of SafariWeb from the specified map of raw messages.

func UnmarshalSendMessageBody 

func UnmarshalSendMessageBody(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSendMessageBody unmarshals an instance of SendMessageBody from the specified map of raw messages.

func UnmarshalSettings 

func UnmarshalSettings(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSettings unmarshals an instance of Settings from the specified map of raw messages.

func UnmarshalStyle 

func UnmarshalStyle(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalStyle unmarshals an instance of Style from the specified map of raw messages.

func UnmarshalTarget 

func UnmarshalTarget(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalTarget unmarshals an instance of Target from the specified map of raw messages.

Types

type Apns 

type Apns struct {
	// The number to display as the badge of the application icon.
	Badge *int64 `json:"badge,omitempty"`

	// The category identifier to be used for the interactive push notifications.
	InteractiveCategory *string `json:"interactiveCategory,omitempty"`

	// __Deprecated__. Use __'interactiveCategory'__ for interactive push notification.
	Category *string `json:"category,omitempty"`

	// The title for the Action key.
	IosActionKey *string `json:"iosActionKey,omitempty"`

	// Custom JSON payload that will be sent as part of the notification message.
	Payload interface{} `json:"payload,omitempty"`

	// The name of the sound file in the application bundle. The sound of this file is played as an alert.
	Sound *string `json:"sound,omitempty"`

	// The key to a title string in the Localizable.strings file for the current localization. The key string can be
	// formatted with %@ and %n$@ specifiers to take the variables specified in the titleLocArgs array.
	TitleLocKey *string `json:"titleLocKey,omitempty"`

	// A key to an alert-message string in a Localizabl.strings file for the current localization (which is set by the
	// user’s language preference).
	//   The key string can be formatted with %@ and %n$@ specifiers to take the variables specified in the locArgs array.
	LocKey *string `json:"locKey,omitempty"`

	// The filename of an image file in the app bundle, with or without the filename extension. The image is used as the
	// launch image when users tap the action button or move the action slider.
	LaunchImage *string `json:"launchImage,omitempty"`

	// Variable string values to appear in place of the format specifiers in title-loc-key.
	TitleLocArgs []string `json:"titleLocArgs,omitempty"`

	// Variable string values to appear in place of the format specifiers in locKey.
	LocArgs []string `json:"locArgs,omitempty"`

	// The title of Rich Push notifications (Supported only on iOS 10 and above).
	Title *string `json:"title,omitempty"`

	// The subtitle of the Rich Notifications.(Supported only on iOS 10 and above).
	Subtitle *string `json:"subtitle,omitempty"`

	// The link to the iOS notifications media (video, audio, GIF, images - Supported only on iOS 10 and above).
	AttachmentURL *string `json:"attachmentUrl,omitempty"`

	Type *string `json:"type,omitempty"`

	// Multiple notifications with the same collapse identifier are displayed to the user as a single notification.
	ApnsCollapseID *string `json:"apnsCollapseId,omitempty"`

	// An app-specific identifier for grouping related notifications. This value corresponds to the threadIdentifier
	// property in the UNNotificationContent object.
	ApnsThreadID *string `json:"apnsThreadId,omitempty"`

	// The string the notification adds to the category’s summary format string.
	ApnsGroupSummaryArg *string `json:"apnsGroupSummaryArg,omitempty"`

	// The number of items the notification adds to the category’s summary format string.
	ApnsGroupSummaryArgCount *int64 `json:"apnsGroupSummaryArgCount,omitempty"`
}

Apns : Settings specific to iOS platform.

type ApnsCertUploadResponse 

type ApnsCertUploadResponse struct {
	// The APNS certificate file name.
	Certificate *string `json:"certificate,omitempty"`

	// Certificate type.
	IsSandBox *bool `json:"isSandBox,omitempty"`

	// The date until which the certificate is valid.
	ValidUntil *string `json:"validUntil,omitempty"`
}

ApnsCertUploadResponse : ApnsCertUploadResponse struct

type AppSettingsObjResponse 

type AppSettingsObjResponse struct {
	// The link to the APNS configuration.
	ApnsConf *string `json:"apnsConf,omitempty"`

	// The link to the GCM configuration.
	GcmConf *string `json:"gcmConf,omitempty"`

	// The link to the Chrome webpush configuration.
	ChromeWebConf *string `json:"chromeWebConf,omitempty"`

	// The link to the Safari Push configuration.
	SafariWebConf *string `json:"safariWebConf,omitempty"`

	// The link to the Firefox webpush configuration.
	FirefoxWebConf *string `json:"firefoxWebConf,omitempty"`
}

AppSettingsObjResponse : AppSettingsObjResponse struct

type ApplicationServerKeyModel 

type ApplicationServerKeyModel struct {
	// Application Server key for Web Push Identification.
	WebpushServerKey *string `json:"webpushServerKey" validate:"required"`
}

ApplicationServerKeyModel : ApplicationServerKeyModel struct

type ChromeAppExt 

type ChromeAppExt struct {
	// Dozed devices to display only the latest notification and discard old low priority notifications.
	CollapseKey *string `json:"collapseKey,omitempty"`

	// When this parameter is set to true, it indicates that the message should not be sent until the device becomes
	// active.
	DelayWhileIdle *bool `json:"delayWhileIdle,omitempty"`

	// Specifies the title to be set for the WebPush Notification.
	Title *string `json:"title,omitempty"`

	// The URL of the icon to be set for the WebPush Notification.
	IconURL *string `json:"iconUrl,omitempty"`

	// This parameter specifies how long (in seconds) the message should be kept in GCM storage if the device is offline.
	TimeToLive *int64 `json:"timeToLive,omitempty"`

	// Custom JSON payload that will be sent as part of the notification message.
	Payload *string `json:"payload,omitempty"`
}

ChromeAppExt : Web Push Notifications settings specific to Chrome browser.

type ChromeWeb 

type ChromeWeb struct {
	// Specifies the title to be set for the WebPush Notification.
	Title *string `json:"title,omitempty"`

	// The URL of the icon to be set for the WebPush Notification.
	IconURL *string `json:"iconUrl,omitempty"`

	// This parameter specifies how long (in seconds) the message should be kept in GCM storage if the device is offline.
	TimeToLive *int64 `json:"timeToLive,omitempty"`

	// Custom JSON payload that will be sent as part of the
	//   notification message.
	Payload *string `json:"payload,omitempty"`
}

ChromeWeb : Web Push Notifications settings specific to Chrome browser.

type ChromeWebPushCredendialsModel 

type ChromeWebPushCredendialsModel struct {
	// An API key that gives the push service an authorized access to Google services that is used for Chrome Web Push.
	ApiKey *string `json:"apiKey" validate:"required"`

	// The URL of the WebSite / WebApp that should be permitted to subscribe to WebPush.
	WebSiteURL *string `json:"webSiteUrl" validate:"required"`
}

ChromeWebPushCredendialsModel : ChromeWebPushCredendialsModel struct

type DeleteApnsConfOptions 

type DeleteApnsConfOptions struct {
	// Unique ID of the application using the push service.
	ApplicationID *string `validate:"required,ne="`

	// The preferred language to use for error messages.
	AcceptLanguage *string

	// Deprecated, use Authorization instead.
	AppSecret *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteApnsConfOptions : The DeleteApnsConf options.

func (*DeleteApnsConfOptions) SetAcceptLanguage 

func (options *DeleteApnsConfOptions) SetAcceptLanguage(acceptLanguage string) *DeleteApnsConfOptions

SetAcceptLanguage : Allow user to set AcceptLanguage

func (*DeleteApnsConfOptions) SetAppSecret 

func (options *DeleteApnsConfOptions) SetAppSecret(appSecret string) *DeleteApnsConfOptions

SetAppSecret : Allow user to set AppSecret

func (*DeleteApnsConfOptions) SetApplicationID 

func (options *DeleteApnsConfOptions) SetApplicationID(applicationID string) *DeleteApnsConfOptions

SetApplicationID : Allow user to set ApplicationID

func (*DeleteApnsConfOptions) SetHeaders 

func (options *DeleteApnsConfOptions) SetHeaders(param map[string]string) *DeleteApnsConfOptions

SetHeaders : Allow user to set Headers

type DeleteChromeAppExtConfOptions 

type DeleteChromeAppExtConfOptions struct {
	// Unique ID of the application using the push service.
	ApplicationID *string `validate:"required,ne="`

	// The preferred language to use for error messages.
	AcceptLanguage *string

	// Deprecated, use Authorization instead.
	AppSecret *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteChromeAppExtConfOptions : The DeleteChromeAppExtConf options.

func (*DeleteChromeAppExtConfOptions) SetAcceptLanguage 

func (options *DeleteChromeAppExtConfOptions) SetAcceptLanguage(acceptLanguage string) *DeleteChromeAppExtConfOptions

SetAcceptLanguage : Allow user to set AcceptLanguage

func (*DeleteChromeAppExtConfOptions) SetAppSecret 

func (options *DeleteChromeAppExtConfOptions) SetAppSecret(appSecret string) *DeleteChromeAppExtConfOptions

SetAppSecret : Allow user to set AppSecret

func (*DeleteChromeAppExtConfOptions) SetApplicationID 

func (options *DeleteChromeAppExtConfOptions) SetApplicationID(applicationID string) *DeleteChromeAppExtConfOptions

SetApplicationID : Allow user to set ApplicationID

func (*DeleteChromeAppExtConfOptions) SetHeaders 

func (options *DeleteChromeAppExtConfOptions) SetHeaders(param map[string]string) *DeleteChromeAppExtConfOptions

SetHeaders : Allow user to set Headers

type DeleteChromeWebConfOptions 

type DeleteChromeWebConfOptions struct {
	// Unique ID of the application using the push service.
	ApplicationID *string `validate:"required,ne="`

	// The preferred language to use for error messages.
	AcceptLanguage *string

	// Deprecated, use Authorization instead.
	AppSecret *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteChromeWebConfOptions : The DeleteChromeWebConf options.

func (*DeleteChromeWebConfOptions) SetAcceptLanguage 

func (options *DeleteChromeWebConfOptions) SetAcceptLanguage(acceptLanguage string) *DeleteChromeWebConfOptions

SetAcceptLanguage : Allow user to set AcceptLanguage

func (*DeleteChromeWebConfOptions) SetAppSecret 

func (options *DeleteChromeWebConfOptions) SetAppSecret(appSecret string) *DeleteChromeWebConfOptions

SetAppSecret : Allow user to set AppSecret

func (*DeleteChromeWebConfOptions) SetApplicationID 

func (options *DeleteChromeWebConfOptions) SetApplicationID(applicationID string) *DeleteChromeWebConfOptions

SetApplicationID : Allow user to set ApplicationID

func (*DeleteChromeWebConfOptions) SetHeaders 

func (options *DeleteChromeWebConfOptions) SetHeaders(param map[string]string) *DeleteChromeWebConfOptions

SetHeaders : Allow user to set Headers

type DeleteFirefoxWebConfOptions 

type DeleteFirefoxWebConfOptions struct {
	// Unique ID of the application using the push service.
	ApplicationID *string `validate:"required,ne="`

	// The preferred language to use for error messages.
	AcceptLanguage *string

	// Deprecated, use Authorization instead.
	AppSecret *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteFirefoxWebConfOptions : The DeleteFirefoxWebConf options.

func (*DeleteFirefoxWebConfOptions) SetAcceptLanguage 

func (options *DeleteFirefoxWebConfOptions) SetAcceptLanguage(acceptLanguage string) *DeleteFirefoxWebConfOptions

SetAcceptLanguage : Allow user to set AcceptLanguage

func (*DeleteFirefoxWebConfOptions) SetAppSecret 

func (options *DeleteFirefoxWebConfOptions) SetAppSecret(appSecret string) *DeleteFirefoxWebConfOptions

SetAppSecret : Allow user to set AppSecret

func (*DeleteFirefoxWebConfOptions) SetApplicationID 

func (options *DeleteFirefoxWebConfOptions) SetApplicationID(applicationID string) *DeleteFirefoxWebConfOptions

SetApplicationID : Allow user to set ApplicationID

func (*DeleteFirefoxWebConfOptions) SetHeaders 

func (options *DeleteFirefoxWebConfOptions) SetHeaders(param map[string]string) *DeleteFirefoxWebConfOptions

SetHeaders : Allow user to set Headers

type DeleteGCMConfOptions 

type DeleteGCMConfOptions struct {
	// Unique ID of the application using the push service.
	ApplicationID *string `validate:"required,ne="`

	// The preferred language to use for error messages.
	AcceptLanguage *string

	// Deprecated, use Authorization instead.
	AppSecret *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteGCMConfOptions : The DeleteGCMConf options.

func (*DeleteGCMConfOptions) SetAcceptLanguage 

func (options *DeleteGCMConfOptions) SetAcceptLanguage(acceptLanguage string) *DeleteGCMConfOptions

SetAcceptLanguage : Allow user to set AcceptLanguage

func (*DeleteGCMConfOptions) SetAppSecret 

func (options *DeleteGCMConfOptions) SetAppSecret(appSecret string) *DeleteGCMConfOptions

SetAppSecret : Allow user to set AppSecret

func (*DeleteGCMConfOptions) SetApplicationID 

func (options *DeleteGCMConfOptions) SetApplicationID(applicationID string) *DeleteGCMConfOptions

SetApplicationID : Allow user to set ApplicationID

func (*DeleteGCMConfOptions) SetHeaders 

func (options *DeleteGCMConfOptions) SetHeaders(param map[string]string) *DeleteGCMConfOptions

SetHeaders : Allow user to set Headers

type DeleteSafariWebConfOptions 

type DeleteSafariWebConfOptions struct {
	// Unique ID of the application using the push service.
	ApplicationID *string `validate:"required,ne="`

	// The preferred language to use for error messages.
	AcceptLanguage *string

	// Deprecated, use Authorization instead.
	AppSecret *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteSafariWebConfOptions : The DeleteSafariWebConf options.

func (*DeleteSafariWebConfOptions) SetAcceptLanguage 

func (options *DeleteSafariWebConfOptions) SetAcceptLanguage(acceptLanguage string) *DeleteSafariWebConfOptions

SetAcceptLanguage : Allow user to set AcceptLanguage

func (*DeleteSafariWebConfOptions) SetAppSecret 

func (options *DeleteSafariWebConfOptions) SetAppSecret(appSecret string) *DeleteSafariWebConfOptions

SetAppSecret : Allow user to set AppSecret

func (*DeleteSafariWebConfOptions) SetApplicationID 

func (options *DeleteSafariWebConfOptions) SetApplicationID(applicationID string) *DeleteSafariWebConfOptions

SetApplicationID : Allow user to set ApplicationID

func (*DeleteSafariWebConfOptions) SetHeaders 

func (options *DeleteSafariWebConfOptions) SetHeaders(param map[string]string) *DeleteSafariWebConfOptions

SetHeaders : Allow user to set Headers

type FirefoxWeb 

type FirefoxWeb struct {
	// Specifies the title to be set for the WebPush Notification.
	Title *string `json:"title,omitempty"`

	// The URL of the icon to be set for the WebPush Notification.
	IconURL *string `json:"iconUrl,omitempty"`

	// This parameter specifies how long (in seconds) the message should be kept in GCM storage if the device is offline.
	TimeToLive *int64 `json:"timeToLive,omitempty"`

	// Custom JSON payload that will be sent as part of the notification message.
	Payload *string `json:"payload,omitempty"`
}

FirefoxWeb : Web Push Notifications settings specific to Mozilla Firefox browser platforms.

type FirefoxWebPushCredendialsModel 

type FirefoxWebPushCredendialsModel struct {
	// The URL of the WebSite / WebApp that should be permitted to subscribe to WebPush.
	WebSiteURL *string `json:"webSiteUrl" validate:"required"`
}

FirefoxWebPushCredendialsModel : FirefoxWebPushCredendialsModel struct

type GCMCredendialsModel 

type GCMCredendialsModel struct {
	// An API key that gives the push service an authorized access to Google services.
	ApiKey *string `json:"apiKey" validate:"required"`

	// Project Number in the Google Developers Console.
	SenderID *string `json:"senderId" validate:"required"`
}

GCMCredendialsModel : GCMCredendialsModel struct

type GCMCredendialsPublicModel 

type GCMCredendialsPublicModel struct {
	// Project Number in the Google Developers Console.
	SenderID *string `json:"senderId" validate:"required"`
}

GCMCredendialsPublicModel : GCMCredendialsPublicModel struct

type Gcm 

type Gcm struct {
	// Dozed devices to display only the latest notification and discard old low priority notifications.
	CollapseKey *string `json:"collapseKey,omitempty"`

	// The category identifier to be used for the interactive push notifications.
	InteractiveCategory *string `json:"interactiveCategory,omitempty"`

	// Specify the name of the icon to be displayed for the notification. Make sure the icon is already packaged with the
	// client application.
	Icon *string `json:"icon,omitempty"`

	// When this parameter is set to true, it indicates that the
	//   message should not be sent until the device becomes active.
	DelayWhileIdle *bool `json:"delayWhileIdle,omitempty"`

	// Device group messaging makes it possible for every app instance in a group to reflect the latest messaging state.
	Sync *bool `json:"sync,omitempty"`

	// private/public - Visibility of this notification, which affects how and when the notifications are revealed on a
	// secure locked screen.
	Visibility *string `json:"visibility,omitempty"`

	// Content specified will show up on a secure locked screen on the device when visibility is set to Private.
	Redact *string `json:"redact,omitempty"`

	// unique Id of the channel to add channel properties.
	ChannelID *string `json:"channelId,omitempty"`

	// Custom JSON payload that will be sent as part of the notification message.
	Payload interface{} `json:"payload,omitempty"`

	// A string value that indicates the priority of this notification. Allowed values are 'max', 'high', 'default', 'low'
	// and 'min'. High/Max priority notifications along with 'sound' field may be used for Heads up notification in Android
	// 5.0 or higher.sampleval='low'.
	Priority *string `json:"priority,omitempty"`

	// The sound file (on device) that will be attempted to play when the notification arrives on the device.
	Sound *string `json:"sound,omitempty"`

	// This parameter specifies how long (in seconds) the message
	//   should be kept in GCM storage if the device is offline.
	TimeToLive *int64 `json:"timeToLive,omitempty"`

	// Allows setting the notification LED color on receiving push notification .
	Lights *Lights `json:"lights,omitempty"`

	// The title of Rich Push notifications.
	AndroidTitle *string `json:"androidTitle,omitempty"`

	// Set this notification to be part of a group of notifications sharing the same key. Grouped notifications may display
	// in a cluster or stack on devices which support such rendering.
	GroupID *string `json:"groupId,omitempty"`

	// Options to specify for Android expandable notifications. The types of expandable notifications are
	// picture_notification, bigtext_notification, inbox_notification.
	Style *Style `json:"style,omitempty"`

	Type *string `json:"type,omitempty"`
}

Gcm : Settings specific to Android platform.

type GetApnsConfOptions 

type GetApnsConfOptions struct {
	// Unique ID of the application using the push service.
	ApplicationID *string `validate:"required,ne="`

	// The preferred language to use for error messages.
	AcceptLanguage *string

	// Deprecated, use Authorization instead.
	AppSecret *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetApnsConfOptions : The GetApnsConf options.

func (*GetApnsConfOptions) SetAcceptLanguage 

func (options *GetApnsConfOptions) SetAcceptLanguage(acceptLanguage string) *GetApnsConfOptions

SetAcceptLanguage : Allow user to set AcceptLanguage

func (*GetApnsConfOptions) SetAppSecret 

func (options *GetApnsConfOptions) SetAppSecret(appSecret string) *GetApnsConfOptions

SetAppSecret : Allow user to set AppSecret

func (*GetApnsConfOptions) SetApplicationID 

func (options *GetApnsConfOptions) SetApplicationID(applicationID string) *GetApnsConfOptions

SetApplicationID : Allow user to set ApplicationID

func (*GetApnsConfOptions) SetHeaders 

func (options *GetApnsConfOptions) SetHeaders(param map[string]string) *GetApnsConfOptions

SetHeaders : Allow user to set Headers

type GetChromeAppExtConfOptions 

type GetChromeAppExtConfOptions struct {
	// Unique ID of the application using the push service.
	ApplicationID *string `validate:"required,ne="`

	// The preferred language to use for error messages.
	AcceptLanguage *string

	// Deprecated, use Authorization instead.
	AppSecret *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetChromeAppExtConfOptions : The GetChromeAppExtConf options.

func (*GetChromeAppExtConfOptions) SetAcceptLanguage 

func (options *GetChromeAppExtConfOptions) SetAcceptLanguage(acceptLanguage string) *GetChromeAppExtConfOptions

SetAcceptLanguage : Allow user to set AcceptLanguage

func (*GetChromeAppExtConfOptions) SetAppSecret 

func (options *GetChromeAppExtConfOptions) SetAppSecret(appSecret string) *GetChromeAppExtConfOptions

SetAppSecret : Allow user to set AppSecret

func (*GetChromeAppExtConfOptions) SetApplicationID 

func (options *GetChromeAppExtConfOptions) SetApplicationID(applicationID string) *GetChromeAppExtConfOptions

SetApplicationID : Allow user to set ApplicationID

func (*GetChromeAppExtConfOptions) SetHeaders 

func (options *GetChromeAppExtConfOptions) SetHeaders(param map[string]string) *GetChromeAppExtConfOptions

SetHeaders : Allow user to set Headers

type GetChromeAppExtConfPublicOptions 

type GetChromeAppExtConfPublicOptions struct {
	// Unique ID of the application using the push service.
	ApplicationID *string `validate:"required,ne="`

	// The clientSecret associated with this application.
	ClientSecret *string

	// The preferred language to use for error messages.
	AcceptLanguage *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetChromeAppExtConfPublicOptions : The GetChromeAppExtConfPublic options.

func (*GetChromeAppExtConfPublicOptions) SetAcceptLanguage 

func (options *GetChromeAppExtConfPublicOptions) SetAcceptLanguage(acceptLanguage string) *GetChromeAppExtConfPublicOptions

SetAcceptLanguage : Allow user to set AcceptLanguage

func (*GetChromeAppExtConfPublicOptions) SetApplicationID 

func (options *GetChromeAppExtConfPublicOptions) SetApplicationID(applicationID string) *GetChromeAppExtConfPublicOptions

SetApplicationID : Allow user to set ApplicationID

func (*GetChromeAppExtConfPublicOptions) SetClientSecret 

func (options *GetChromeAppExtConfPublicOptions) SetClientSecret(clientSecret string) *GetChromeAppExtConfPublicOptions

SetClientSecret : Allow user to set ClientSecret

func (*GetChromeAppExtConfPublicOptions) SetHeaders 

func (options *GetChromeAppExtConfPublicOptions) SetHeaders(param map[string]string) *GetChromeAppExtConfPublicOptions

SetHeaders : Allow user to set Headers

type GetChromeWebConfOptions 

type GetChromeWebConfOptions struct {
	// Unique ID of the application using the push service.
	ApplicationID *string `validate:"required,ne="`

	// The preferred language to use for error messages.
	AcceptLanguage *string

	// Deprecated, use Authorization instead.
	AppSecret *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetChromeWebConfOptions : The GetChromeWebConf options.

func (*GetChromeWebConfOptions) SetAcceptLanguage 

func (options *GetChromeWebConfOptions) SetAcceptLanguage(acceptLanguage string) *GetChromeWebConfOptions

SetAcceptLanguage : Allow user to set AcceptLanguage

func (*GetChromeWebConfOptions) SetAppSecret 

func (options *GetChromeWebConfOptions) SetAppSecret(appSecret string) *GetChromeWebConfOptions

SetAppSecret : Allow user to set AppSecret

func (*GetChromeWebConfOptions) SetApplicationID 

func (options *GetChromeWebConfOptions) SetApplicationID(applicationID string) *GetChromeWebConfOptions

SetApplicationID : Allow user to set ApplicationID

func (*GetChromeWebConfOptions) SetHeaders 

func (options *GetChromeWebConfOptions) SetHeaders(param map[string]string) *GetChromeWebConfOptions

SetHeaders : Allow user to set Headers

type GetFirefoxWebConfOptions 

type GetFirefoxWebConfOptions struct {
	// Unique ID of the application using the push service.
	ApplicationID *string `validate:"required,ne="`

	// The preferred language to use for error messages.
	AcceptLanguage *string

	// Deprecated, use Authorization instead.
	AppSecret *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetFirefoxWebConfOptions : The GetFirefoxWebConf options.

func (*GetFirefoxWebConfOptions) SetAcceptLanguage 

func (options *GetFirefoxWebConfOptions) SetAcceptLanguage(acceptLanguage string) *GetFirefoxWebConfOptions

SetAcceptLanguage : Allow user to set AcceptLanguage

func (*GetFirefoxWebConfOptions) SetAppSecret 

func (options *GetFirefoxWebConfOptions) SetAppSecret(appSecret string) *GetFirefoxWebConfOptions

SetAppSecret : Allow user to set AppSecret

func (*GetFirefoxWebConfOptions) SetApplicationID 

func (options *GetFirefoxWebConfOptions) SetApplicationID(applicationID string) *GetFirefoxWebConfOptions

SetApplicationID : Allow user to set ApplicationID

func (*GetFirefoxWebConfOptions) SetHeaders 

func (options *GetFirefoxWebConfOptions) SetHeaders(param map[string]string) *GetFirefoxWebConfOptions

SetHeaders : Allow user to set Headers

type GetGCMConfOptions 

type GetGCMConfOptions struct {
	// Unique ID of the application using the push service.
	ApplicationID *string `validate:"required,ne="`

	// The preferred language to use for error messages.
	AcceptLanguage *string

	// Deprecated, use Authorization instead.
	AppSecret *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetGCMConfOptions : The GetGCMConf options.

func (*GetGCMConfOptions) SetAcceptLanguage 

func (options *GetGCMConfOptions) SetAcceptLanguage(acceptLanguage string) *GetGCMConfOptions

SetAcceptLanguage : Allow user to set AcceptLanguage

func (*GetGCMConfOptions) SetAppSecret 

func (options *GetGCMConfOptions) SetAppSecret(appSecret string) *GetGCMConfOptions

SetAppSecret : Allow user to set AppSecret

func (*GetGCMConfOptions) SetApplicationID 

func (options *GetGCMConfOptions) SetApplicationID(applicationID string) *GetGCMConfOptions

SetApplicationID : Allow user to set ApplicationID

func (*GetGCMConfOptions) SetHeaders 

func (options *GetGCMConfOptions) SetHeaders(param map[string]string) *GetGCMConfOptions

SetHeaders : Allow user to set Headers

type GetGcmConfPublicOptions 

type GetGcmConfPublicOptions struct {
	// Unique ID of the application using the push service.
	ApplicationID *string `validate:"required,ne="`

	// The clientSecret associated with this application.
	ClientSecret *string

	// The preferred language to use for error messages.
	AcceptLanguage *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetGcmConfPublicOptions : The GetGcmConfPublic options.

func (*GetGcmConfPublicOptions) SetAcceptLanguage 

func (options *GetGcmConfPublicOptions) SetAcceptLanguage(acceptLanguage string) *GetGcmConfPublicOptions

SetAcceptLanguage : Allow user to set AcceptLanguage

func (*GetGcmConfPublicOptions) SetApplicationID 

func (options *GetGcmConfPublicOptions) SetApplicationID(applicationID string) *GetGcmConfPublicOptions

SetApplicationID : Allow user to set ApplicationID

func (*GetGcmConfPublicOptions) SetClientSecret 

func (options *GetGcmConfPublicOptions) SetClientSecret(clientSecret string) *GetGcmConfPublicOptions

SetClientSecret : Allow user to set ClientSecret

func (*GetGcmConfPublicOptions) SetHeaders 

func (options *GetGcmConfPublicOptions) SetHeaders(param map[string]string) *GetGcmConfPublicOptions

SetHeaders : Allow user to set Headers

type GetSafariWebConfOptions 

type GetSafariWebConfOptions struct {
	// Unique ID of the application using the push service.
	ApplicationID *string `validate:"required,ne="`

	// The preferred language to use for error messages.
	AcceptLanguage *string

	// Deprecated, use Authorization instead.
	AppSecret *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetSafariWebConfOptions : The GetSafariWebConf options.

func (*GetSafariWebConfOptions) SetAcceptLanguage 

func (options *GetSafariWebConfOptions) SetAcceptLanguage(acceptLanguage string) *GetSafariWebConfOptions

SetAcceptLanguage : Allow user to set AcceptLanguage

func (*GetSafariWebConfOptions) SetAppSecret 

func (options *GetSafariWebConfOptions) SetAppSecret(appSecret string) *GetSafariWebConfOptions

SetAppSecret : Allow user to set AppSecret

func (*GetSafariWebConfOptions) SetApplicationID 

func (options *GetSafariWebConfOptions) SetApplicationID(applicationID string) *GetSafariWebConfOptions

SetApplicationID : Allow user to set ApplicationID

func (*GetSafariWebConfOptions) SetHeaders 

func (options *GetSafariWebConfOptions) SetHeaders(param map[string]string) *GetSafariWebConfOptions

SetHeaders : Allow user to set Headers

type GetSettingsOptions 

type GetSettingsOptions struct {
	// Unique ID of the application using the push service.
	ApplicationID *string `validate:"required,ne="`

	// Deprecated, use Authorization instead.
	AppSecret *string

	// The preferred language to use for error messages.
	AcceptLanguage *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetSettingsOptions : The GetSettings options.

func (*GetSettingsOptions) SetAcceptLanguage 

func (options *GetSettingsOptions) SetAcceptLanguage(acceptLanguage string) *GetSettingsOptions

SetAcceptLanguage : Allow user to set AcceptLanguage

func (*GetSettingsOptions) SetAppSecret 

func (options *GetSettingsOptions) SetAppSecret(appSecret string) *GetSettingsOptions

SetAppSecret : Allow user to set AppSecret

func (*GetSettingsOptions) SetApplicationID 

func (options *GetSettingsOptions) SetApplicationID(applicationID string) *GetSettingsOptions

SetApplicationID : Allow user to set ApplicationID

func (*GetSettingsOptions) SetHeaders 

func (options *GetSettingsOptions) SetHeaders(param map[string]string) *GetSettingsOptions

SetHeaders : Allow user to set Headers

type GetWebpushServerKeyOptions 

type GetWebpushServerKeyOptions struct {
	// Unique ID of the application server for the IBM Cloud Push Notification Service identification for web push
	// communication.
	ApplicationID *string `validate:"required,ne="`

	// Deprecated, use Authorization instead.
	ClientSecret *string

	// The preferred language to use for error messages.
	AcceptLanguage *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetWebpushServerKeyOptions : The GetWebpushServerKey options.

func (*GetWebpushServerKeyOptions) SetAcceptLanguage 

func (options *GetWebpushServerKeyOptions) SetAcceptLanguage(acceptLanguage string) *GetWebpushServerKeyOptions

SetAcceptLanguage : Allow user to set AcceptLanguage

func (*GetWebpushServerKeyOptions) SetApplicationID 

func (options *GetWebpushServerKeyOptions) SetApplicationID(applicationID string) *GetWebpushServerKeyOptions

SetApplicationID : Allow user to set ApplicationID

func (*GetWebpushServerKeyOptions) SetClientSecret 

func (options *GetWebpushServerKeyOptions) SetClientSecret(clientSecret string) *GetWebpushServerKeyOptions

SetClientSecret : Allow user to set ClientSecret

func (*GetWebpushServerKeyOptions) SetHeaders 

func (options *GetWebpushServerKeyOptions) SetHeaders(param map[string]string) *GetWebpushServerKeyOptions

SetHeaders : Allow user to set Headers

type Lights 

type Lights struct {
	// The color of the led. The hardware will do its best approximation.
	LedArgb *string `json:"ledArgb,omitempty"`

	// The number of milliseconds for the LED to be on while it's flashing. The hardware will do its best approximation.
	LedOnMs *int64 `json:"ledOnMs,omitempty"`

	// The number of milliseconds for the LED to be off while it's flashing. The hardware will do its best approximation.
	LedOffMs *string `json:"ledOffMs,omitempty"`
}

Lights : Allows setting the notification LED color on receiving push notification .

type Message 

type Message struct {
	// The notification message to be shown to the user.
	Alert *string `json:"alert,omitempty"`

	// An optional URL that can be sent along with the alert.
	URL *string `json:"url,omitempty"`
}

Message : Details of the content of the notification message.

type MessageResponseModel 

type MessageResponseModel struct {
	Message *SendMessageBody `json:"message,omitempty"`

	// Unique Id for the message.
	MessageID *string `json:"messageId,omitempty"`
}

MessageResponseModel : MessageResponseModel struct

type MessagesArrayModel 

type MessagesArrayModel struct {
	// An array of messages.
	Messages []MessagesList `json:"messages,omitempty"`
}

MessagesArrayModel : MessagesArrayModel struct

type MessagesList 

type MessagesList struct {
	// Created time of the message.
	CreatedTime *string `json:"createdTime,omitempty"`

	// Unique identifier of the message.
	MessageID *string `json:"messageId,omitempty"`

	// Message text.
	Alert *string `json:"alert,omitempty"`

	// The URL to the message resource.
	Href *string `json:"href,omitempty"`
}

MessagesList : MessagesList struct

type PushServiceV1 

type PushServiceV1 struct {
	Service *core.BaseService
}

PushServiceV1 : No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Version: 1.0

func NewPushServiceV1 

func NewPushServiceV1(options *PushServiceV1Options) (service *PushServiceV1, err error)

NewPushServiceV1 : constructs an instance of PushServiceV1 with passed in options.

func NewPushServiceV1UsingExternalConfig 

func NewPushServiceV1UsingExternalConfig(options *PushServiceV1Options) (pushService *PushServiceV1, err error)

NewPushServiceV1UsingExternalConfig : constructs an instance of PushServiceV1 with passed in options and external configuration.

func (*PushServiceV1) Clone 

func (pushService *PushServiceV1) Clone() *PushServiceV1

Clone makes a copy of "pushService" suitable for processing requests.

func (*PushServiceV1) DeleteApnsConf 

func (pushService *PushServiceV1) DeleteApnsConf(deleteApnsConfOptions *DeleteApnsConfOptions) (response *core.DetailedResponse, err error)

DeleteApnsConf : Delete APNS settings Deletes the APNS settings to the application referenced by the applicationId.

func (*PushServiceV1) DeleteApnsConfWithContext 

func (pushService *PushServiceV1) DeleteApnsConfWithContext(ctx context.Context, deleteApnsConfOptions *DeleteApnsConfOptions) (response *core.DetailedResponse, err error)

DeleteApnsConfWithContext is an alternate form of the DeleteApnsConf method which supports a Context parameter

func (*PushServiceV1) DeleteChromeAppExtConf 

func (pushService *PushServiceV1) DeleteChromeAppExtConf(deleteChromeAppExtConfOptions *DeleteChromeAppExtConfOptions) (response *core.DetailedResponse, err error)

DeleteChromeAppExtConf : Delete Chorme Apps-Extentions Push credentials settings Deletes the push credentials settings for Chrome Apps-Extensions of the application, which is referenced by the applicationId parameter.

func (*PushServiceV1) DeleteChromeAppExtConfWithContext 

func (pushService *PushServiceV1) DeleteChromeAppExtConfWithContext(ctx context.Context, deleteChromeAppExtConfOptions *DeleteChromeAppExtConfOptions) (response *core.DetailedResponse, err error)

DeleteChromeAppExtConfWithContext is an alternate form of the DeleteChromeAppExtConf method which supports a Context parameter

func (*PushServiceV1) DeleteChromeWebConf 

func (pushService *PushServiceV1) DeleteChromeWebConf(deleteChromeWebConfOptions *DeleteChromeWebConfOptions) (response *core.DetailedResponse, err error)

DeleteChromeWebConf : Delete Chrome WebPush Settings Deletes the Chrome WebPush credentials of the application, which is referenced by the applicationId parameter.

func (*PushServiceV1) DeleteChromeWebConfWithContext 

func (pushService *PushServiceV1) DeleteChromeWebConfWithContext(ctx context.Context, deleteChromeWebConfOptions *DeleteChromeWebConfOptions) (response *core.DetailedResponse, err error)

DeleteChromeWebConfWithContext is an alternate form of the DeleteChromeWebConf method which supports a Context parameter

func (*PushServiceV1) DeleteFirefoxWebConf 

func (pushService *PushServiceV1) DeleteFirefoxWebConf(deleteFirefoxWebConfOptions *DeleteFirefoxWebConfOptions) (response *core.DetailedResponse, err error)

DeleteFirefoxWebConf : Delete Firefox WebPush Settings Deletes the Firefox WebPush credentials of the application, which is referenced by the applicationId parameter.

func (*PushServiceV1) DeleteFirefoxWebConfWithContext 

func (pushService *PushServiceV1) DeleteFirefoxWebConfWithContext(ctx context.Context, deleteFirefoxWebConfOptions *DeleteFirefoxWebConfOptions) (response *core.DetailedResponse, err error)

DeleteFirefoxWebConfWithContext is an alternate form of the DeleteFirefoxWebConf method which supports a Context parameter

func (*PushServiceV1) DeleteGCMConf 

func (pushService *PushServiceV1) DeleteGCMConf(deleteGCMConfOptions *DeleteGCMConfOptions) (response *core.DetailedResponse, err error)

DeleteGCMConf : Delete GCM settings Deletes the GCM credentials of the application, which is referenced by the applicationId parameter.

func (*PushServiceV1) DeleteGCMConfWithContext 

func (pushService *PushServiceV1) DeleteGCMConfWithContext(ctx context.Context, deleteGCMConfOptions *DeleteGCMConfOptions) (response *core.DetailedResponse, err error)

DeleteGCMConfWithContext is an alternate form of the DeleteGCMConf method which supports a Context parameter

func (*PushServiceV1) DeleteSafariWebConf 

func (pushService *PushServiceV1) DeleteSafariWebConf(deleteSafariWebConfOptions *DeleteSafariWebConfOptions) (response *core.DetailedResponse, err error)

DeleteSafariWebConf : Delete Safari Push Notifications settings Deletes the Safari Push Notifications settings of the application, which is referenced by the applicationId parameter.

func (*PushServiceV1) DeleteSafariWebConfWithContext 

func (pushService *PushServiceV1) DeleteSafariWebConfWithContext(ctx context.Context, deleteSafariWebConfOptions *DeleteSafariWebConfOptions) (response *core.DetailedResponse, err error)

DeleteSafariWebConfWithContext is an alternate form of the DeleteSafariWebConf method which supports a Context parameter

func (*PushServiceV1) DisableRetries 

func (pushService *PushServiceV1) DisableRetries()

DisableRetries disables automatic retries for requests invoked for this service instance.

func (*PushServiceV1) EnableRetries 

func (pushService *PushServiceV1) EnableRetries(maxRetries int, maxRetryInterval time.Duration)

EnableRetries enables automatic retries for requests invoked for this service instance. If either parameter is specified as 0, then a default value is used instead.

func (*PushServiceV1) GetApnsConf 

func (pushService *PushServiceV1) GetApnsConf(getApnsConfOptions *GetApnsConfOptions) (result *ApnsCertUploadResponse, response *core.DetailedResponse, err error)

GetApnsConf : Get the APNS settings Retrieves APNS credentials for the application.

func (*PushServiceV1) GetApnsConfWithContext 

func (pushService *PushServiceV1) GetApnsConfWithContext(ctx context.Context, getApnsConfOptions *GetApnsConfOptions) (result *ApnsCertUploadResponse, response *core.DetailedResponse, err error)

GetApnsConfWithContext is an alternate form of the GetApnsConf method which supports a Context parameter

func (*PushServiceV1) GetChromeAppExtConf 

func (pushService *PushServiceV1) GetChromeAppExtConf(getChromeAppExtConfOptions *GetChromeAppExtConfOptions) (result *GCMCredendialsModel, response *core.DetailedResponse, err error)

GetChromeAppExtConf : Get the Chorme Apps-Extentions Push credentials settings Retrieves Chorme Apps-Extentions Push credentials settings for the application.

func (*PushServiceV1) GetChromeAppExtConfPublic 

func (pushService *PushServiceV1) GetChromeAppExtConfPublic(getChromeAppExtConfPublicOptions *GetChromeAppExtConfPublicOptions) (result *GCMCredendialsPublicModel, response *core.DetailedResponse, err error)

GetChromeAppExtConfPublic : Get the GCM senderId for Chorme Apps-Extentions Push credentials Retrieves GCM senderId only for Chorme Apps-Extentions Push credentials of the application.

func (*PushServiceV1) GetChromeAppExtConfPublicWithContext 

func (pushService *PushServiceV1) GetChromeAppExtConfPublicWithContext(ctx context.Context, getChromeAppExtConfPublicOptions *GetChromeAppExtConfPublicOptions) (result *GCMCredendialsPublicModel, response *core.DetailedResponse, err error)

GetChromeAppExtConfPublicWithContext is an alternate form of the GetChromeAppExtConfPublic method which supports a Context parameter

func (*PushServiceV1) GetChromeAppExtConfWithContext 

func (pushService *PushServiceV1) GetChromeAppExtConfWithContext(ctx context.Context, getChromeAppExtConfOptions *GetChromeAppExtConfOptions) (result *GCMCredendialsModel, response *core.DetailedResponse, err error)

GetChromeAppExtConfWithContext is an alternate form of the GetChromeAppExtConf method which supports a Context parameter

func (*PushServiceV1) GetChromeWebConf 

func (pushService *PushServiceV1) GetChromeWebConf(getChromeWebConfOptions *GetChromeWebConfOptions) (result *ChromeWebPushCredendialsModel, response *core.DetailedResponse, err error)

GetChromeWebConf : Get the Chrome WebPush settings Retrieves Chrome WebPush credentials for the application.

func (*PushServiceV1) GetChromeWebConfWithContext 

func (pushService *PushServiceV1) GetChromeWebConfWithContext(ctx context.Context, getChromeWebConfOptions *GetChromeWebConfOptions) (result *ChromeWebPushCredendialsModel, response *core.DetailedResponse, err error)

GetChromeWebConfWithContext is an alternate form of the GetChromeWebConf method which supports a Context parameter

func (*PushServiceV1) GetEnableGzipCompression 

func (pushService *PushServiceV1) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

func (*PushServiceV1) GetFirefoxWebConf 

func (pushService *PushServiceV1) GetFirefoxWebConf(getFirefoxWebConfOptions *GetFirefoxWebConfOptions) (result *FirefoxWebPushCredendialsModel, response *core.DetailedResponse, err error)

GetFirefoxWebConf : Get the Firefox WebPush settings Retrieves Firefox WebPush credentials for the application.

func (*PushServiceV1) GetFirefoxWebConfWithContext 

func (pushService *PushServiceV1) GetFirefoxWebConfWithContext(ctx context.Context, getFirefoxWebConfOptions *GetFirefoxWebConfOptions) (result *FirefoxWebPushCredendialsModel, response *core.DetailedResponse, err error)

GetFirefoxWebConfWithContext is an alternate form of the GetFirefoxWebConf method which supports a Context parameter

func (*PushServiceV1) GetGCMConf 

func (pushService *PushServiceV1) GetGCMConf(getGCMConfOptions *GetGCMConfOptions) (result *GCMCredendialsModel, response *core.DetailedResponse, err error)

GetGCMConf : Get the GCM settings Retrieves GCM credentials for the application.

func (*PushServiceV1) GetGCMConfWithContext 

func (pushService *PushServiceV1) GetGCMConfWithContext(ctx context.Context, getGCMConfOptions *GetGCMConfOptions) (result *GCMCredendialsModel, response *core.DetailedResponse, err error)

GetGCMConfWithContext is an alternate form of the GetGCMConf method which supports a Context parameter

func (*PushServiceV1) GetGcmConfPublic 

func (pushService *PushServiceV1) GetGcmConfPublic(getGcmConfPublicOptions *GetGcmConfPublicOptions) (result *GCMCredendialsPublicModel, response *core.DetailedResponse, err error)

GetGcmConfPublic : Get the GCM senderId Retrieves GCM senderId only for the application.

func (*PushServiceV1) GetGcmConfPublicWithContext 

func (pushService *PushServiceV1) GetGcmConfPublicWithContext(ctx context.Context, getGcmConfPublicOptions *GetGcmConfPublicOptions) (result *GCMCredendialsPublicModel, response *core.DetailedResponse, err error)

GetGcmConfPublicWithContext is an alternate form of the GetGcmConfPublic method which supports a Context parameter

func (*PushServiceV1) GetSafariWebConf 

func (pushService *PushServiceV1) GetSafariWebConf(getSafariWebConfOptions *GetSafariWebConfOptions) (result *SafariCertUploadResponse, response *core.DetailedResponse, err error)

GetSafariWebConf : Get the Safari Push Notifications settings Retrieves Safari Push Notifications settings for the application.

func (*PushServiceV1) GetSafariWebConfWithContext 

func (pushService *PushServiceV1) GetSafariWebConfWithContext(ctx context.Context, getSafariWebConfOptions *GetSafariWebConfOptions) (result *SafariCertUploadResponse, response *core.DetailedResponse, err error)

GetSafariWebConfWithContext is an alternate form of the GetSafariWebConf method which supports a Context parameter

func (*PushServiceV1) GetServiceURL 

func (pushService *PushServiceV1) GetServiceURL() string

GetServiceURL returns the service URL

func (*PushServiceV1) GetSettings 

func (pushService *PushServiceV1) GetSettings(getSettingsOptions *GetSettingsOptions) (result *AppSettingsObjResponse, response *core.DetailedResponse, err error)

GetSettings : Retrieve application settings Retrieves the application settings, which is referenced by the applicationId parameter.

func (*PushServiceV1) GetSettingsWithContext 

func (pushService *PushServiceV1) GetSettingsWithContext(ctx context.Context, getSettingsOptions *GetSettingsOptions) (result *AppSettingsObjResponse, response *core.DetailedResponse, err error)

GetSettingsWithContext is an alternate form of the GetSettings method which supports a Context parameter

func (*PushServiceV1) GetWebpushServerKey 

func (pushService *PushServiceV1) GetWebpushServerKey(getWebpushServerKeyOptions *GetWebpushServerKeyOptions) (result *ApplicationServerKeyModel, response *core.DetailedResponse, err error)

GetWebpushServerKey : Get the Web Push Server Key Retrieves Web Push Server Key (VAPID).

func (*PushServiceV1) GetWebpushServerKeyWithContext 

func (pushService *PushServiceV1) GetWebpushServerKeyWithContext(ctx context.Context, getWebpushServerKeyOptions *GetWebpushServerKeyOptions) (result *ApplicationServerKeyModel, response *core.DetailedResponse, err error)

GetWebpushServerKeyWithContext is an alternate form of the GetWebpushServerKey method which supports a Context parameter

func (*PushServiceV1) NewChromeWebPushCredendialsModel 

func (*PushServiceV1) NewChromeWebPushCredendialsModel(apiKey string, webSiteURL string) (model *ChromeWebPushCredendialsModel, err error)

NewChromeWebPushCredendialsModel : Instantiate ChromeWebPushCredendialsModel (Generic Model Constructor)

func (*PushServiceV1) NewDeleteApnsConfOptions 

func (*PushServiceV1) NewDeleteApnsConfOptions(applicationID string) *DeleteApnsConfOptions

NewDeleteApnsConfOptions : Instantiate DeleteApnsConfOptions

func (*PushServiceV1) NewDeleteChromeAppExtConfOptions 

func (*PushServiceV1) NewDeleteChromeAppExtConfOptions(applicationID string) *DeleteChromeAppExtConfOptions

NewDeleteChromeAppExtConfOptions : Instantiate DeleteChromeAppExtConfOptions

func (*PushServiceV1) NewDeleteChromeWebConfOptions 

func (*PushServiceV1) NewDeleteChromeWebConfOptions(applicationID string) *DeleteChromeWebConfOptions

NewDeleteChromeWebConfOptions : Instantiate DeleteChromeWebConfOptions

func (*PushServiceV1) NewDeleteFirefoxWebConfOptions 

func (*PushServiceV1) NewDeleteFirefoxWebConfOptions(applicationID string) *DeleteFirefoxWebConfOptions

NewDeleteFirefoxWebConfOptions : Instantiate DeleteFirefoxWebConfOptions

func (*PushServiceV1) NewDeleteGCMConfOptions 

func (*PushServiceV1) NewDeleteGCMConfOptions(applicationID string) *DeleteGCMConfOptions

NewDeleteGCMConfOptions : Instantiate DeleteGCMConfOptions

func (*PushServiceV1) NewDeleteSafariWebConfOptions 

func (*PushServiceV1) NewDeleteSafariWebConfOptions(applicationID string) *DeleteSafariWebConfOptions

NewDeleteSafariWebConfOptions : Instantiate DeleteSafariWebConfOptions

func (*PushServiceV1) NewFirefoxWebPushCredendialsModel 

func (*PushServiceV1) NewFirefoxWebPushCredendialsModel(webSiteURL string) (model *FirefoxWebPushCredendialsModel, err error)

NewFirefoxWebPushCredendialsModel : Instantiate FirefoxWebPushCredendialsModel (Generic Model Constructor)

func (*PushServiceV1) NewGCMCredendialsModel 

func (*PushServiceV1) NewGCMCredendialsModel(apiKey string, senderID string) (model *GCMCredendialsModel, err error)

NewGCMCredendialsModel : Instantiate GCMCredendialsModel (Generic Model Constructor)

func (*PushServiceV1) NewGetApnsConfOptions 

func (*PushServiceV1) NewGetApnsConfOptions(applicationID string) *GetApnsConfOptions

NewGetApnsConfOptions : Instantiate GetApnsConfOptions

func (*PushServiceV1) NewGetChromeAppExtConfOptions 

func (*PushServiceV1) NewGetChromeAppExtConfOptions(applicationID string) *GetChromeAppExtConfOptions

NewGetChromeAppExtConfOptions : Instantiate GetChromeAppExtConfOptions

func (*PushServiceV1) NewGetChromeAppExtConfPublicOptions 

func (*PushServiceV1) NewGetChromeAppExtConfPublicOptions(applicationID string) *GetChromeAppExtConfPublicOptions

NewGetChromeAppExtConfPublicOptions : Instantiate GetChromeAppExtConfPublicOptions

func (*PushServiceV1) NewGetChromeWebConfOptions 

func (*PushServiceV1) NewGetChromeWebConfOptions(applicationID string) *GetChromeWebConfOptions

NewGetChromeWebConfOptions : Instantiate GetChromeWebConfOptions

func (*PushServiceV1) NewGetFirefoxWebConfOptions 

func (*PushServiceV1) NewGetFirefoxWebConfOptions(applicationID string) *GetFirefoxWebConfOptions

NewGetFirefoxWebConfOptions : Instantiate GetFirefoxWebConfOptions

func (*PushServiceV1) NewGetGCMConfOptions 

func (*PushServiceV1) NewGetGCMConfOptions(applicationID string) *GetGCMConfOptions

NewGetGCMConfOptions : Instantiate GetGCMConfOptions

func (*PushServiceV1) NewGetGcmConfPublicOptions 

func (*PushServiceV1) NewGetGcmConfPublicOptions(applicationID string) *GetGcmConfPublicOptions

NewGetGcmConfPublicOptions : Instantiate GetGcmConfPublicOptions

func (*PushServiceV1) NewGetSafariWebConfOptions 

func (*PushServiceV1) NewGetSafariWebConfOptions(applicationID string) *GetSafariWebConfOptions

NewGetSafariWebConfOptions : Instantiate GetSafariWebConfOptions

func (*PushServiceV1) NewGetSettingsOptions 

func (*PushServiceV1) NewGetSettingsOptions(applicationID string) *GetSettingsOptions

NewGetSettingsOptions : Instantiate GetSettingsOptions

func (*PushServiceV1) NewGetWebpushServerKeyOptions 

func (*PushServiceV1) NewGetWebpushServerKeyOptions(applicationID string) *GetWebpushServerKeyOptions

NewGetWebpushServerKeyOptions : Instantiate GetWebpushServerKeyOptions

func (*PushServiceV1) NewSaveApnsConfOptions 

func (*PushServiceV1) NewSaveApnsConfOptions(applicationID string, password string, isSandBox bool, certificate io.ReadCloser) *SaveApnsConfOptions

NewSaveApnsConfOptions : Instantiate SaveApnsConfOptions

func (*PushServiceV1) NewSaveChromeAppExtConfOptions 

func (*PushServiceV1) NewSaveChromeAppExtConfOptions(applicationID string, apiKey string, senderID string) *SaveChromeAppExtConfOptions

NewSaveChromeAppExtConfOptions : Instantiate SaveChromeAppExtConfOptions

func (*PushServiceV1) NewSaveChromeWebConfOptions 

func (*PushServiceV1) NewSaveChromeWebConfOptions(applicationID string, apiKey string, webSiteURL string) *SaveChromeWebConfOptions

NewSaveChromeWebConfOptions : Instantiate SaveChromeWebConfOptions

func (*PushServiceV1) NewSaveFirefoxWebConfOptions 

func (*PushServiceV1) NewSaveFirefoxWebConfOptions(applicationID string, webSiteURL string) *SaveFirefoxWebConfOptions

NewSaveFirefoxWebConfOptions : Instantiate SaveFirefoxWebConfOptions

func (*PushServiceV1) NewSaveGCMConfOptions 

func (*PushServiceV1) NewSaveGCMConfOptions(applicationID string, apiKey string, senderID string) *SaveGCMConfOptions

NewSaveGCMConfOptions : Instantiate SaveGCMConfOptions

func (*PushServiceV1) NewSaveSafariWebConfOptions 

func (*PushServiceV1) NewSaveSafariWebConfOptions(applicationID string, password string, certificate io.ReadCloser, websiteName string, urlFormatString string, websitePushID string, webSiteURL string) *SaveSafariWebConfOptions

NewSaveSafariWebConfOptions : Instantiate SaveSafariWebConfOptions

func (*PushServiceV1) NewSendMessageBody 

func (*PushServiceV1) NewSendMessageBody(message *Message) (model *SendMessageBody, err error)

NewSendMessageBody : Instantiate SendMessageBody (Generic Model Constructor)

func (*PushServiceV1) NewSendMessageOptions 

func (*PushServiceV1) NewSendMessageOptions(applicationID string, message *Message) *SendMessageOptions

NewSendMessageOptions : Instantiate SendMessageOptions

func (*PushServiceV1) NewSendMessagesInBulkOptions 

func (*PushServiceV1) NewSendMessagesInBulkOptions(applicationID string, body []SendMessageBody) *SendMessagesInBulkOptions

NewSendMessagesInBulkOptions : Instantiate SendMessagesInBulkOptions

func (*PushServiceV1) SaveApnsConf 

func (pushService *PushServiceV1) SaveApnsConf(saveApnsConfOptions *SaveApnsConfOptions) (result *ApnsCertUploadResponse, response *core.DetailedResponse, err error)

SaveApnsConf : Updates APNS settings Uploads an APNS certificate to the application referenced by the applicationId.

func (*PushServiceV1) SaveApnsConfWithContext 

func (pushService *PushServiceV1) SaveApnsConfWithContext(ctx context.Context, saveApnsConfOptions *SaveApnsConfOptions) (result *ApnsCertUploadResponse, response *core.DetailedResponse, err error)

SaveApnsConfWithContext is an alternate form of the SaveApnsConf method which supports a Context parameter

func (*PushServiceV1) SaveChromeAppExtConf 

func (pushService *PushServiceV1) SaveChromeAppExtConf(saveChromeAppExtConfOptions *SaveChromeAppExtConfOptions) (result *GCMCredendialsModel, response *core.DetailedResponse, err error)

SaveChromeAppExtConf : Updates Chorme Apps-Extentions Push credentials settings Updates the Chorme Apps-Extentions Push credentials settings of the application referenced by the applicationId.

func (*PushServiceV1) SaveChromeAppExtConfWithContext 

func (pushService *PushServiceV1) SaveChromeAppExtConfWithContext(ctx context.Context, saveChromeAppExtConfOptions *SaveChromeAppExtConfOptions) (result *GCMCredendialsModel, response *core.DetailedResponse, err error)

SaveChromeAppExtConfWithContext is an alternate form of the SaveChromeAppExtConf method which supports a Context parameter

func (*PushServiceV1) SaveChromeWebConf 

func (pushService *PushServiceV1) SaveChromeWebConf(saveChromeWebConfOptions *SaveChromeWebConfOptions) (result *ChromeWebPushCredendialsModel, response *core.DetailedResponse, err error)

SaveChromeWebConf : Updates Chrome WebPush settings Updates the Chrome WebPush credentials of the application referenced by the applicationId.

func (*PushServiceV1) SaveChromeWebConfWithContext 

func (pushService *PushServiceV1) SaveChromeWebConfWithContext(ctx context.Context, saveChromeWebConfOptions *SaveChromeWebConfOptions) (result *ChromeWebPushCredendialsModel, response *core.DetailedResponse, err error)

SaveChromeWebConfWithContext is an alternate form of the SaveChromeWebConf method which supports a Context parameter

func (*PushServiceV1) SaveFirefoxWebConf 

func (pushService *PushServiceV1) SaveFirefoxWebConf(saveFirefoxWebConfOptions *SaveFirefoxWebConfOptions) (result *FirefoxWebPushCredendialsModel, response *core.DetailedResponse, err error)

SaveFirefoxWebConf : Updates Firefox WebPush settings Updates the Firefox WebPush credentials of the application referenced by the applicationId.

func (*PushServiceV1) SaveFirefoxWebConfWithContext 

func (pushService *PushServiceV1) SaveFirefoxWebConfWithContext(ctx context.Context, saveFirefoxWebConfOptions *SaveFirefoxWebConfOptions) (result *FirefoxWebPushCredendialsModel, response *core.DetailedResponse, err error)

SaveFirefoxWebConfWithContext is an alternate form of the SaveFirefoxWebConf method which supports a Context parameter

func (*PushServiceV1) SaveGCMConf 

func (pushService *PushServiceV1) SaveGCMConf(saveGCMConfOptions *SaveGCMConfOptions) (result *GCMCredendialsModel, response *core.DetailedResponse, err error)

SaveGCMConf : Updates GCM settings Updates the GCM credentials of the application referenced by the applicationId.

func (*PushServiceV1) SaveGCMConfWithContext 

func (pushService *PushServiceV1) SaveGCMConfWithContext(ctx context.Context, saveGCMConfOptions *SaveGCMConfOptions) (result *GCMCredendialsModel, response *core.DetailedResponse, err error)

SaveGCMConfWithContext is an alternate form of the SaveGCMConf method which supports a Context parameter

func (*PushServiceV1) SaveSafariWebConf 

func (pushService *PushServiceV1) SaveSafariWebConf(saveSafariWebConfOptions *SaveSafariWebConfOptions) (result *SafariCertUploadResponse, response *core.DetailedResponse, err error)

SaveSafariWebConf : Updates Safari Push Notifications settings Uploads Safari Push Notifications settings to the application referenced by the applicationId. The settings include providing a web push certificate and other credentials. If none of the icons are provided then default icons will be used. These images populate the icons displayed to the user in the permission prompt, Notification Center and the notification itself.

func (*PushServiceV1) SaveSafariWebConfWithContext 

func (pushService *PushServiceV1) SaveSafariWebConfWithContext(ctx context.Context, saveSafariWebConfOptions *SaveSafariWebConfOptions) (result *SafariCertUploadResponse, response *core.DetailedResponse, err error)

SaveSafariWebConfWithContext is an alternate form of the SaveSafariWebConf method which supports a Context parameter

func (*PushServiceV1) SendMessage 

func (pushService *PushServiceV1) SendMessage(sendMessageOptions *SendMessageOptions) (result *MessageResponseModel, response *core.DetailedResponse, err error)

SendMessage : Send message with different options When the request to send the message is accepted, sends push notifications to the specified targets and returns HTTP return code 202. The sent messages are stored and would auto expire in 10 days. You would not be able to retrieve information about a message using GET, after this specified time limit. Available in server side frameworks.

func (*PushServiceV1) SendMessageWithContext 

func (pushService *PushServiceV1) SendMessageWithContext(ctx context.Context, sendMessageOptions *SendMessageOptions) (result *MessageResponseModel, response *core.DetailedResponse, err error)

SendMessageWithContext is an alternate form of the SendMessage method which supports a Context parameter

func (*PushServiceV1) SendMessagesInBulk 

func (pushService *PushServiceV1) SendMessagesInBulk(sendMessagesInBulkOptions *SendMessagesInBulkOptions) (result *MessagesArrayModel, response *core.DetailedResponse, err error)

SendMessagesInBulk : Send Bulk Messages Send bulk messages with different options to be specified. The sent messages are stored and would auto expire in 10 days. You would not be able to retrieve information about a message using GET, after this specified time limit. Available in server side frameworks.

func (*PushServiceV1) SendMessagesInBulkWithContext 

func (pushService *PushServiceV1) SendMessagesInBulkWithContext(ctx context.Context, sendMessagesInBulkOptions *SendMessagesInBulkOptions) (result *MessagesArrayModel, response *core.DetailedResponse, err error)

SendMessagesInBulkWithContext is an alternate form of the SendMessagesInBulk method which supports a Context parameter

func (*PushServiceV1) SetDefaultHeaders 

func (pushService *PushServiceV1) SetDefaultHeaders(headers http.Header)

SetDefaultHeaders sets HTTP headers to be sent in every request

func (*PushServiceV1) SetEnableGzipCompression 

func (pushService *PushServiceV1) SetEnableGzipCompression(enableGzip bool)

SetEnableGzipCompression sets the service's EnableGzipCompression field

func (*PushServiceV1) SetServiceURL 

func (pushService *PushServiceV1) SetServiceURL(url string) error

SetServiceURL sets the service URL

type PushServiceV1Options 

type PushServiceV1Options struct {
	ServiceName   string
	URL           string
	Authenticator core.Authenticator
}

PushServiceV1Options : Service options

type SafariCertUploadResponse 

type SafariCertUploadResponse struct {
	// The APNS certificate file name.
	Certificate *string `json:"certificate,omitempty"`

	// The website name. This is the heading used in Notification Center.
	WebsiteName *string `json:"websiteName,omitempty"`

	// The URL to go when the notification is clicked.
	UrlFormatString *string `json:"urlFormatString,omitempty"`

	// Unique reverse-domain string for your Website Push ID.
	WebsitePushID interface{} `json:"websitePushID,omitempty"`

	// The URL of the website that should be permitted to subscribe to Safari Push Notifications.
	WebSiteURL interface{} `json:"webSiteUrl,omitempty"`
}

SafariCertUploadResponse : SafariCertUploadResponse struct

type SafariWeb 

type SafariWeb struct {
	// Specifies the title to be set for the Safari Push Notifications.
	Title *string `json:"title,omitempty"`

	// The URL arguments that need to be used with this notification. This has to provided in the form of a JSON Array.
	UrlArgs []string `json:"urlArgs,omitempty"`

	// The label of the action button.
	Action *string `json:"action,omitempty"`
}

SafariWeb : Web Push Notifications settings specific to Safari browser.

type SaveApnsConfOptions 

type SaveApnsConfOptions struct {
	// Unique ID of the application using the push service.
	ApplicationID *string `validate:"required,ne="`

	// Password for the APNS certificate.
	Password *string `validate:"required"`

	// Type of the APNS certificate.
	IsSandBox *bool `validate:"required"`

	// The APNS certificate.
	Certificate io.ReadCloser `validate:"required"`

	// The content type of certificate.
	CertificateContentType *string

	// The preferred language to use for error messages.
	AcceptLanguage *string

	// Deprecated, use Authorization instead.
	AppSecret *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

SaveApnsConfOptions : The SaveApnsConf options.

func (*SaveApnsConfOptions) SetAcceptLanguage 

func (options *SaveApnsConfOptions) SetAcceptLanguage(acceptLanguage string) *SaveApnsConfOptions

SetAcceptLanguage : Allow user to set AcceptLanguage

func (*SaveApnsConfOptions) SetAppSecret 

func (options *SaveApnsConfOptions) SetAppSecret(appSecret string) *SaveApnsConfOptions

SetAppSecret : Allow user to set AppSecret

func (*SaveApnsConfOptions) SetApplicationID 

func (options *SaveApnsConfOptions) SetApplicationID(applicationID string) *SaveApnsConfOptions

SetApplicationID : Allow user to set ApplicationID

func (*SaveApnsConfOptions) SetCertificate 

func (options *SaveApnsConfOptions) SetCertificate(certificate io.ReadCloser) *SaveApnsConfOptions

SetCertificate : Allow user to set Certificate

func (*SaveApnsConfOptions) SetCertificateContentType 

func (options *SaveApnsConfOptions) SetCertificateContentType(certificateContentType string) *SaveApnsConfOptions

SetCertificateContentType : Allow user to set CertificateContentType

func (*SaveApnsConfOptions) SetHeaders 

func (options *SaveApnsConfOptions) SetHeaders(param map[string]string) *SaveApnsConfOptions

SetHeaders : Allow user to set Headers

func (*SaveApnsConfOptions) SetIsSandBox 

func (options *SaveApnsConfOptions) SetIsSandBox(isSandBox bool) *SaveApnsConfOptions

SetIsSandBox : Allow user to set IsSandBox

func (*SaveApnsConfOptions) SetPassword 

func (options *SaveApnsConfOptions) SetPassword(password string) *SaveApnsConfOptions

SetPassword : Allow user to set Password

type SaveChromeAppExtConfOptions 

type SaveChromeAppExtConfOptions struct {
	// Unique ID of the application using the push service.
	ApplicationID *string `validate:"required,ne="`

	// An API key that gives the push service an authorized access to Google services.
	ApiKey *string `validate:"required"`

	// Project Number in the Google Developers Console.
	SenderID *string `validate:"required"`

	// The preferred language to use for error messages.
	AcceptLanguage *string

	// Deprecated, use Authorization instead.
	AppSecret *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

SaveChromeAppExtConfOptions : The SaveChromeAppExtConf options.

func (*SaveChromeAppExtConfOptions) SetAcceptLanguage 

func (options *SaveChromeAppExtConfOptions) SetAcceptLanguage(acceptLanguage string) *SaveChromeAppExtConfOptions

SetAcceptLanguage : Allow user to set AcceptLanguage

func (*SaveChromeAppExtConfOptions) SetApiKey 

func (options *SaveChromeAppExtConfOptions) SetApiKey(apiKey string) *SaveChromeAppExtConfOptions

SetApiKey : Allow user to set ApiKey

func (*SaveChromeAppExtConfOptions) SetAppSecret 

func (options *SaveChromeAppExtConfOptions) SetAppSecret(appSecret string) *SaveChromeAppExtConfOptions

SetAppSecret : Allow user to set AppSecret

func (*SaveChromeAppExtConfOptions) SetApplicationID 

func (options *SaveChromeAppExtConfOptions) SetApplicationID(applicationID string) *SaveChromeAppExtConfOptions

SetApplicationID : Allow user to set ApplicationID

func (*SaveChromeAppExtConfOptions) SetHeaders 

func (options *SaveChromeAppExtConfOptions) SetHeaders(param map[string]string) *SaveChromeAppExtConfOptions

SetHeaders : Allow user to set Headers

func (*SaveChromeAppExtConfOptions) SetSenderID 

func (options *SaveChromeAppExtConfOptions) SetSenderID(senderID string) *SaveChromeAppExtConfOptions

SetSenderID : Allow user to set SenderID

type SaveChromeWebConfOptions 

type SaveChromeWebConfOptions struct {
	// Unique ID of the application using the push service.
	ApplicationID *string `validate:"required,ne="`

	// An API key that gives the push service an authorized access to Google services that is used for Chrome Web Push.
	ApiKey *string `validate:"required"`

	// The URL of the WebSite / WebApp that should be permitted to subscribe to WebPush.
	WebSiteURL *string `validate:"required"`

	// The preferred language to use for error messages.
	AcceptLanguage *string

	// Deprecated, use Authorization instead.
	AppSecret *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

SaveChromeWebConfOptions : The SaveChromeWebConf options.

func (*SaveChromeWebConfOptions) SetAcceptLanguage 

func (options *SaveChromeWebConfOptions) SetAcceptLanguage(acceptLanguage string) *SaveChromeWebConfOptions

SetAcceptLanguage : Allow user to set AcceptLanguage

func (*SaveChromeWebConfOptions) SetApiKey 

func (options *SaveChromeWebConfOptions) SetApiKey(apiKey string) *SaveChromeWebConfOptions

SetApiKey : Allow user to set ApiKey

func (*SaveChromeWebConfOptions) SetAppSecret 

func (options *SaveChromeWebConfOptions) SetAppSecret(appSecret string) *SaveChromeWebConfOptions

SetAppSecret : Allow user to set AppSecret

func (*SaveChromeWebConfOptions) SetApplicationID 

func (options *SaveChromeWebConfOptions) SetApplicationID(applicationID string) *SaveChromeWebConfOptions

SetApplicationID : Allow user to set ApplicationID

func (*SaveChromeWebConfOptions) SetHeaders 

func (options *SaveChromeWebConfOptions) SetHeaders(param map[string]string) *SaveChromeWebConfOptions

SetHeaders : Allow user to set Headers

func (*SaveChromeWebConfOptions) SetWebSiteURL 

func (options *SaveChromeWebConfOptions) SetWebSiteURL(webSiteURL string) *SaveChromeWebConfOptions

SetWebSiteURL : Allow user to set WebSiteURL

type SaveFirefoxWebConfOptions 

type SaveFirefoxWebConfOptions struct {
	// Unique ID of the application using the push service.
	ApplicationID *string `validate:"required,ne="`

	// The URL of the WebSite / WebApp that should be permitted to subscribe to WebPush.
	WebSiteURL *string `validate:"required"`

	// The preferred language to use for error messages.
	AcceptLanguage *string

	// Deprecated, use Authorization instead.
	AppSecret *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

SaveFirefoxWebConfOptions : The SaveFirefoxWebConf options.

func (*SaveFirefoxWebConfOptions) SetAcceptLanguage 

func (options *SaveFirefoxWebConfOptions) SetAcceptLanguage(acceptLanguage string) *SaveFirefoxWebConfOptions

SetAcceptLanguage : Allow user to set AcceptLanguage

func (*SaveFirefoxWebConfOptions) SetAppSecret 

func (options *SaveFirefoxWebConfOptions) SetAppSecret(appSecret string) *SaveFirefoxWebConfOptions

SetAppSecret : Allow user to set AppSecret

func (*SaveFirefoxWebConfOptions) SetApplicationID 

func (options *SaveFirefoxWebConfOptions) SetApplicationID(applicationID string) *SaveFirefoxWebConfOptions

SetApplicationID : Allow user to set ApplicationID

func (*SaveFirefoxWebConfOptions) SetHeaders 

func (options *SaveFirefoxWebConfOptions) SetHeaders(param map[string]string) *SaveFirefoxWebConfOptions

SetHeaders : Allow user to set Headers

func (*SaveFirefoxWebConfOptions) SetWebSiteURL 

func (options *SaveFirefoxWebConfOptions) SetWebSiteURL(webSiteURL string) *SaveFirefoxWebConfOptions

SetWebSiteURL : Allow user to set WebSiteURL

type SaveGCMConfOptions 

type SaveGCMConfOptions struct {
	// Unique ID of the application using the push service.
	ApplicationID *string `validate:"required,ne="`

	// An API key that gives the push service an authorized access to Google services.
	ApiKey *string `validate:"required"`

	// Project Number in the Google Developers Console.
	SenderID *string `validate:"required"`

	// The preferred language to use for error messages.
	AcceptLanguage *string

	// Deprecated, use Authorization instead.
	AppSecret *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

SaveGCMConfOptions : The SaveGCMConf options.

func (*SaveGCMConfOptions) SetAcceptLanguage 

func (options *SaveGCMConfOptions) SetAcceptLanguage(acceptLanguage string) *SaveGCMConfOptions

SetAcceptLanguage : Allow user to set AcceptLanguage

func (*SaveGCMConfOptions) SetApiKey 

func (options *SaveGCMConfOptions) SetApiKey(apiKey string) *SaveGCMConfOptions

SetApiKey : Allow user to set ApiKey

func (*SaveGCMConfOptions) SetAppSecret 

func (options *SaveGCMConfOptions) SetAppSecret(appSecret string) *SaveGCMConfOptions

SetAppSecret : Allow user to set AppSecret

func (*SaveGCMConfOptions) SetApplicationID 

func (options *SaveGCMConfOptions) SetApplicationID(applicationID string) *SaveGCMConfOptions

SetApplicationID : Allow user to set ApplicationID

func (*SaveGCMConfOptions) SetHeaders 

func (options *SaveGCMConfOptions) SetHeaders(param map[string]string) *SaveGCMConfOptions

SetHeaders : Allow user to set Headers

func (*SaveGCMConfOptions) SetSenderID 

func (options *SaveGCMConfOptions) SetSenderID(senderID string) *SaveGCMConfOptions

SetSenderID : Allow user to set SenderID

type SaveSafariWebConfOptions 

type SaveSafariWebConfOptions struct {
	// Unique ID of the application using the push service.
	ApplicationID *string `validate:"required,ne="`

	// Password for the web push certificate.
	Password *string `validate:"required"`

	// The Safari web push certificate (p12 format).
	Certificate io.ReadCloser `validate:"required"`

	// The website name. This is the heading used in Notification Center.
	WebsiteName *string `validate:"required"`

	// The URL to go to when the notification is clicked. Use %@ as a placeholder for arguments you fill in when delivering
	// your notification. This URL must use the http or https scheme; otherwise, it is invalid.
	UrlFormatString *string `validate:"required"`

	// Unique reverse-domain string for your Website Push ID such as web.com.example.domain (the string must start with
	// web).
	WebsitePushID *string `validate:"required"`

	// The URL of the website that should be permitted to subscribe to Safari Push Notifications.
	WebSiteURL *string `validate:"required"`

	// The content type of certificate.
	CertificateContentType *string

	// PNG icon file of 16x16 size.
	Icon16x16 io.ReadCloser

	// The content type of icon16x16.
	Icon16x16ContentType *string

	// PNG icon file of 16x16@2x size.
	Icon16x162x io.ReadCloser

	// The content type of icon16x162x.
	Icon16x162xContentType *string

	// PNG icon file of 32x32 size.
	Icon32x32 io.ReadCloser

	// The content type of icon32x32.
	Icon32x32ContentType *string

	// PNG icon file of 32x32@2x size.
	Icon32x322x io.ReadCloser

	// The content type of icon32x322x.
	Icon32x322xContentType *string

	// PNG icon file of 128x128 size.
	Icon128x128 io.ReadCloser

	// The content type of icon128x128.
	Icon128x128ContentType *string

	// PNG icon file of 128x128@2x size.
	Icon128x1282x io.ReadCloser

	// The content type of icon128x1282x.
	Icon128x1282xContentType *string

	// The preferred language to use for error messages.
	AcceptLanguage *string

	// Deprecated, use Authorization instead.
	AppSecret *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

SaveSafariWebConfOptions : The SaveSafariWebConf options.

func (*SaveSafariWebConfOptions) SetAcceptLanguage 

func (options *SaveSafariWebConfOptions) SetAcceptLanguage(acceptLanguage string) *SaveSafariWebConfOptions

SetAcceptLanguage : Allow user to set AcceptLanguage

func (*SaveSafariWebConfOptions) SetAppSecret 

func (options *SaveSafariWebConfOptions) SetAppSecret(appSecret string) *SaveSafariWebConfOptions

SetAppSecret : Allow user to set AppSecret

func (*SaveSafariWebConfOptions) SetApplicationID 

func (options *SaveSafariWebConfOptions) SetApplicationID(applicationID string) *SaveSafariWebConfOptions

SetApplicationID : Allow user to set ApplicationID

func (*SaveSafariWebConfOptions) SetCertificate 

func (options *SaveSafariWebConfOptions) SetCertificate(certificate io.ReadCloser) *SaveSafariWebConfOptions

SetCertificate : Allow user to set Certificate

func (*SaveSafariWebConfOptions) SetCertificateContentType 

func (options *SaveSafariWebConfOptions) SetCertificateContentType(certificateContentType string) *SaveSafariWebConfOptions

SetCertificateContentType : Allow user to set CertificateContentType

func (*SaveSafariWebConfOptions) SetHeaders 

func (options *SaveSafariWebConfOptions) SetHeaders(param map[string]string) *SaveSafariWebConfOptions

SetHeaders : Allow user to set Headers

func (*SaveSafariWebConfOptions) SetIcon128x128 

func (options *SaveSafariWebConfOptions) SetIcon128x128(icon128x128 io.ReadCloser) *SaveSafariWebConfOptions

SetIcon128x128 : Allow user to set Icon128x128

func (*SaveSafariWebConfOptions) SetIcon128x1282x 

func (options *SaveSafariWebConfOptions) SetIcon128x1282x(icon128x1282x io.ReadCloser) *SaveSafariWebConfOptions

SetIcon128x1282x : Allow user to set Icon128x1282x

func (*SaveSafariWebConfOptions) SetIcon128x1282xContentType 

func (options *SaveSafariWebConfOptions) SetIcon128x1282xContentType(icon128x1282xContentType string) *SaveSafariWebConfOptions

SetIcon128x1282xContentType : Allow user to set Icon128x1282xContentType

func (*SaveSafariWebConfOptions) SetIcon128x128ContentType 

func (options *SaveSafariWebConfOptions) SetIcon128x128ContentType(icon128x128ContentType string) *SaveSafariWebConfOptions

SetIcon128x128ContentType : Allow user to set Icon128x128ContentType

func (*SaveSafariWebConfOptions) SetIcon16x16 

func (options *SaveSafariWebConfOptions) SetIcon16x16(icon16x16 io.ReadCloser) *SaveSafariWebConfOptions

SetIcon16x16 : Allow user to set Icon16x16

func (*SaveSafariWebConfOptions) SetIcon16x162x 

func (options *SaveSafariWebConfOptions) SetIcon16x162x(icon16x162x io.ReadCloser) *SaveSafariWebConfOptions

SetIcon16x162x : Allow user to set Icon16x162x

func (*SaveSafariWebConfOptions) SetIcon16x162xContentType 

func (options *SaveSafariWebConfOptions) SetIcon16x162xContentType(icon16x162xContentType string) *SaveSafariWebConfOptions

SetIcon16x162xContentType : Allow user to set Icon16x162xContentType

func (*SaveSafariWebConfOptions) SetIcon16x16ContentType 

func (options *SaveSafariWebConfOptions) SetIcon16x16ContentType(icon16x16ContentType string) *SaveSafariWebConfOptions

SetIcon16x16ContentType : Allow user to set Icon16x16ContentType

func (*SaveSafariWebConfOptions) SetIcon32x32 

func (options *SaveSafariWebConfOptions) SetIcon32x32(icon32x32 io.ReadCloser) *SaveSafariWebConfOptions

SetIcon32x32 : Allow user to set Icon32x32

func (*SaveSafariWebConfOptions) SetIcon32x322x 

func (options *SaveSafariWebConfOptions) SetIcon32x322x(icon32x322x io.ReadCloser) *SaveSafariWebConfOptions

SetIcon32x322x : Allow user to set Icon32x322x

func (*SaveSafariWebConfOptions) SetIcon32x322xContentType 

func (options *SaveSafariWebConfOptions) SetIcon32x322xContentType(icon32x322xContentType string) *SaveSafariWebConfOptions

SetIcon32x322xContentType : Allow user to set Icon32x322xContentType

func (*SaveSafariWebConfOptions) SetIcon32x32ContentType 

func (options *SaveSafariWebConfOptions) SetIcon32x32ContentType(icon32x32ContentType string) *SaveSafariWebConfOptions

SetIcon32x32ContentType : Allow user to set Icon32x32ContentType

func (*SaveSafariWebConfOptions) SetPassword 

func (options *SaveSafariWebConfOptions) SetPassword(password string) *SaveSafariWebConfOptions

SetPassword : Allow user to set Password

func (*SaveSafariWebConfOptions) SetUrlFormatString 

func (options *SaveSafariWebConfOptions) SetUrlFormatString(urlFormatString string) *SaveSafariWebConfOptions

SetUrlFormatString : Allow user to set UrlFormatString

func (*SaveSafariWebConfOptions) SetWebSiteURL 

func (options *SaveSafariWebConfOptions) SetWebSiteURL(webSiteURL string) *SaveSafariWebConfOptions

SetWebSiteURL : Allow user to set WebSiteURL

func (*SaveSafariWebConfOptions) SetWebsiteName 

func (options *SaveSafariWebConfOptions) SetWebsiteName(websiteName string) *SaveSafariWebConfOptions

SetWebsiteName : Allow user to set WebsiteName

func (*SaveSafariWebConfOptions) SetWebsitePushID 

func (options *SaveSafariWebConfOptions) SetWebsitePushID(websitePushID string) *SaveSafariWebConfOptions

SetWebsitePushID : Allow user to set WebsitePushID

type SendMessageBody 

type SendMessageBody struct {
	// Details of the content of the notification message.
	Message *Message `json:"message" validate:"required"`

	// Additional properties that can be configured for the notification.
	Settings *Settings `json:"settings,omitempty"`

	// Validate the devices.
	Validate *bool `json:"validate,omitempty"`

	// An optional target for the message. Specify one of the target parameters to choose the recipients of the
	// notification. If no target is specified, a broadcast notification will be sent to all the registered devices.
	Target *Target `json:"target,omitempty"`
}

SendMessageBody : SendMessageBody struct

type SendMessageOptions 

type SendMessageOptions struct {
	// Unique ID of the application using the push service.
	ApplicationID *string `validate:"required,ne="`

	// Details of the content of the notification message.
	Message *Message `validate:"required"`

	// Additional properties that can be configured for the notification.
	Settings *Settings

	// Validate the devices.
	Validate *bool

	// An optional target for the message. Specify one of the target parameters to choose the recipients of the
	// notification. If no target is specified, a broadcast notification will be sent to all the registered devices.
	Target *Target

	// The preferred language to use for error messages.
	AcceptLanguage *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

SendMessageOptions : The SendMessage options.

func (*SendMessageOptions) SetAcceptLanguage 

func (options *SendMessageOptions) SetAcceptLanguage(acceptLanguage string) *SendMessageOptions

SetAcceptLanguage : Allow user to set AcceptLanguage

func (*SendMessageOptions) SetApplicationID 

func (options *SendMessageOptions) SetApplicationID(applicationID string) *SendMessageOptions

SetApplicationID : Allow user to set ApplicationID

func (*SendMessageOptions) SetHeaders 

func (options *SendMessageOptions) SetHeaders(param map[string]string) *SendMessageOptions

SetHeaders : Allow user to set Headers

func (*SendMessageOptions) SetMessage 

func (options *SendMessageOptions) SetMessage(message *Message) *SendMessageOptions

SetMessage : Allow user to set Message

func (*SendMessageOptions) SetSettings 

func (options *SendMessageOptions) SetSettings(settings *Settings) *SendMessageOptions

SetSettings : Allow user to set Settings

func (*SendMessageOptions) SetTarget 

func (options *SendMessageOptions) SetTarget(target *Target) *SendMessageOptions

SetTarget : Allow user to set Target

func (*SendMessageOptions) SetValidate 

func (options *SendMessageOptions) SetValidate(validate bool) *SendMessageOptions

SetValidate : Allow user to set Validate

type SendMessagesInBulkOptions 

type SendMessagesInBulkOptions struct {
	// Application ID.
	ApplicationID *string `validate:"required,ne="`

	Body []SendMessageBody `validate:"required"`

	// The preferred language to use for error messages.
	AcceptLanguage *string

	// Deprecated, use Authorization instead.
	AppSecret *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

SendMessagesInBulkOptions : The SendMessagesInBulk options.

func (*SendMessagesInBulkOptions) SetAcceptLanguage 

func (options *SendMessagesInBulkOptions) SetAcceptLanguage(acceptLanguage string) *SendMessagesInBulkOptions

SetAcceptLanguage : Allow user to set AcceptLanguage

func (*SendMessagesInBulkOptions) SetAppSecret 

func (options *SendMessagesInBulkOptions) SetAppSecret(appSecret string) *SendMessagesInBulkOptions

SetAppSecret : Allow user to set AppSecret

func (*SendMessagesInBulkOptions) SetApplicationID 

func (options *SendMessagesInBulkOptions) SetApplicationID(applicationID string) *SendMessagesInBulkOptions

SetApplicationID : Allow user to set ApplicationID

func (*SendMessagesInBulkOptions) SetBody 

func (options *SendMessagesInBulkOptions) SetBody(body []SendMessageBody) *SendMessagesInBulkOptions

SetBody : Allow user to set Body

func (*SendMessagesInBulkOptions) SetHeaders 

func (options *SendMessagesInBulkOptions) SetHeaders(param map[string]string) *SendMessagesInBulkOptions

SetHeaders : Allow user to set Headers

type Settings 

type Settings struct {
	// Settings specific to iOS platform.
	Apns *Apns `json:"apns,omitempty"`

	// Settings specific to Android platform.
	Gcm *Gcm `json:"gcm,omitempty"`

	// Web Push Notifications settings specific to Mozilla Firefox browser platforms.
	FirefoxWeb *FirefoxWeb `json:"firefoxWeb,omitempty"`

	// Web Push Notifications settings specific to Chrome  browser.
	ChromeWeb *ChromeWeb `json:"chromeWeb,omitempty"`

	// Web Push Notifications settings specific to Safari  browser.
	SafariWeb *SafariWeb `json:"safariWeb,omitempty"`

	// Web Push Notifications settings specific to Chrome  browser.
	ChromeAppExt *ChromeAppExt `json:"chromeAppExt,omitempty"`
}

Settings : Additional properties that can be configured for the notification.

type Style 

type Style struct {
	// Specifies the type of expandable notifications.  The possible values are bigtext_notification, picture_notification,
	// inbox_notification.
	Type *string `json:"type,omitempty"`

	// Specifies the title of the notification.  The title is displayed when the notification is expanded.  Title must be
	// specified for all three expandable notification.
	Title *string `json:"title,omitempty"`

	// An URL from which the picture has to be obtained for the notification.  Must be specified for picture_notification.
	URL *string `json:"url,omitempty"`

	// The big text that needs to be displayed on expanding a bigtext_notification.  Must be specified for
	// bigtext_notification.
	Text *string `json:"text,omitempty"`

	// An array of strings that is to be displayed in inbox style for inbox_notification.  Must be specified for
	// inbox_notification.
	Lines []string `json:"lines,omitempty"`
}

Style : Options to specify for Android expandable notifications. The types of expandable notifications are picture_notification, bigtext_notification, inbox_notification.

type Target 

type Target struct {
	// Send notification to the list of specified devices.
	DeviceIds []string `json:"deviceIds,omitempty"`

	// Send notification to the specified userIds.
	UserIds []string `json:"userIds,omitempty"`

	// Send notification to the devices of the specified platforms. 'A' for apple (iOS) devices, 'G' for google (Android)
	// devices, 'WEB_CHROME' for Chrome Web Browsers, 'WEB_FIREFOX' for Firefox Web Browsers, 'WEB_SAFARI' for Safari Push
	// Notifications and 'APPEXT_CHROME' for Chrome App Extension.
	Platforms []string `json:"platforms,omitempty"`

	// Send notification to the devices that have subscribed to any of
	//   these tags.
	TagNames []string `json:"tagNames,omitempty"`
}

Target : An optional target for the message. Specify one of the target parameters to choose the recipients of the notification. If no target is specified, a broadcast notification will be sent to all the registered devices.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.