mobileengagement

package
v7.0.0-beta+incompatible Latest Latest
Warning

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

 Go to latest Published: Nov 29, 2016 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

Package mobileengagement implements the Azure ARM Mobileengagement service API version 2014-12-01.

Microsoft Azure Mobile Engagement REST APIs.

Index

Constants

View Source 
const (
	// APIVersion is the version of the Mobileengagement
	APIVersion = "2014-12-01"

	// DefaultBaseURI is the default URI used for the service Mobileengagement
	DefaultBaseURI = "https://management.azure.com"
)

Variables

This section is empty.

Functions

func UserAgent 

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version 

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type APIError 

type APIError struct {
	Error *APIErrorError `json:"error,omitempty"`
}

APIError is

type APIErrorError 

type APIErrorError struct {
	Code    *string `json:"code,omitempty"`
	Message *string `json:"message,omitempty"`
}

APIErrorError is

type AnnouncementFeedbackCriterion 

type AnnouncementFeedbackCriterion struct {
	ContentID *int32            `json:"content-id,omitempty"`
	Action    CampaignFeedbacks `json:"action,omitempty"`
}

AnnouncementFeedbackCriterion is used to target devices who received an announcement.

type App 

type App struct {
	ID             *string             `json:"id,omitempty"`
	Name           *string             `json:"name,omitempty"`
	Type           *string             `json:"type,omitempty"`
	Location       *string             `json:"location,omitempty"`
	Tags           *map[string]*string `json:"tags,omitempty"`
	*AppProperties `json:"properties,omitempty"`
}

App is the Mobile Engagement App resource.

type AppCollection 

type AppCollection struct {
	ID                       *string             `json:"id,omitempty"`
	Name                     *string             `json:"name,omitempty"`
	Type                     *string             `json:"type,omitempty"`
	Location                 *string             `json:"location,omitempty"`
	Tags                     *map[string]*string `json:"tags,omitempty"`
	*AppCollectionProperties `json:"properties,omitempty"`
}

AppCollection is the AppCollection resource.

type AppCollectionListResult 

type AppCollectionListResult struct {
	autorest.Response `json:"-"`
	Value             *[]AppCollection `json:"value,omitempty"`
	NextLink          *string          `json:"nextLink,omitempty"`
}

AppCollectionListResult is the list AppCollections operation response.

func (AppCollectionListResult) AppCollectionListResultPreparer 

func (client AppCollectionListResult) AppCollectionListResultPreparer() (*http.Request, error)

AppCollectionListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type AppCollectionNameAvailability 

type AppCollectionNameAvailability struct {
	autorest.Response    `json:"-"`
	Name                 *string `json:"name,omitempty"`
	Available            *bool   `json:"available,omitempty"`
	UnavailabilityReason *string `json:"unavailabilityReason,omitempty"`
}

AppCollectionNameAvailability is

type AppCollectionProperties 

type AppCollectionProperties struct {
	ProvisioningState ProvisioningStates `json:"provisioningState,omitempty"`
}

AppCollectionProperties is

type AppCollectionsClient 

type AppCollectionsClient struct {
	ManagementClient
}

AppCollectionsClient is the microsoft Azure Mobile Engagement REST APIs.

func NewAppCollectionsClient 

func NewAppCollectionsClient(subscriptionID string, resourceGroupName string, appCollection string, appName string) AppCollectionsClient

NewAppCollectionsClient creates an instance of the AppCollectionsClient client.

func NewAppCollectionsClientWithBaseURI 

func NewAppCollectionsClientWithBaseURI(baseURI string, subscriptionID string, resourceGroupName string, appCollection string, appName string) AppCollectionsClient

NewAppCollectionsClientWithBaseURI creates an instance of the AppCollectionsClient client.

func (AppCollectionsClient) CheckNameAvailability 

func (client AppCollectionsClient) CheckNameAvailability(parameters AppCollectionNameAvailability) (result AppCollectionNameAvailability, err error)

CheckNameAvailability checks availability of an app collection name in the Engagement domain.

func (AppCollectionsClient) CheckNameAvailabilityPreparer 

func (client AppCollectionsClient) CheckNameAvailabilityPreparer(parameters AppCollectionNameAvailability) (*http.Request, error)

CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.

func (AppCollectionsClient) CheckNameAvailabilityResponder 

func (client AppCollectionsClient) CheckNameAvailabilityResponder(resp *http.Response) (result AppCollectionNameAvailability, err error)

CheckNameAvailabilityResponder handles the response to the CheckNameAvailability request. The method always closes the http.Response Body.

func (AppCollectionsClient) CheckNameAvailabilitySender 

func (client AppCollectionsClient) CheckNameAvailabilitySender(req *http.Request) (*http.Response, error)

CheckNameAvailabilitySender sends the CheckNameAvailability request. The method will close the http.Response Body if it receives an error.

func (AppCollectionsClient) List 

func (client AppCollectionsClient) List() (result AppCollectionListResult, err error)

List lists app collections in a subscription.

func (AppCollectionsClient) ListNextResults 

func (client AppCollectionsClient) ListNextResults(lastResults AppCollectionListResult) (result AppCollectionListResult, err error)

ListNextResults retrieves the next set of results, if any.

func (AppCollectionsClient) ListPreparer 

func (client AppCollectionsClient) ListPreparer() (*http.Request, error)

ListPreparer prepares the List request.

func (AppCollectionsClient) ListResponder 

func (client AppCollectionsClient) ListResponder(resp *http.Response) (result AppCollectionListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (AppCollectionsClient) ListSender 

func (client AppCollectionsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type AppInfoFilter 

type AppInfoFilter struct {
	AppInfo *[]string `json:"appInfo,omitempty"`
}

AppInfoFilter is send only to users who have some app info set. This is a special filter that is automatically added if your campaign contains appInfo parameters. It is not intended to be public and should not be used as it could be removed or replaced by the API.

type AppListResult 

type AppListResult struct {
	autorest.Response `json:"-"`
	Value             *[]App  `json:"value,omitempty"`
	NextLink          *string `json:"nextLink,omitempty"`
}

AppListResult is the list Apps operation response.

func (AppListResult) AppListResultPreparer 

func (client AppListResult) AppListResultPreparer() (*http.Request, error)

AppListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type AppProperties 

type AppProperties struct {
	BackendID *string `json:"backendId,omitempty"`
	Platform  *string `json:"platform,omitempty"`
	AppState  *string `json:"appState,omitempty"`
}

AppProperties is

type ApplicationVersionCriterion 

type ApplicationVersionCriterion struct {
	Name *string `json:"name,omitempty"`
}

ApplicationVersionCriterion is used to target devices based on the version of the application they are using.

type AppsClient 

type AppsClient struct {
	ManagementClient
}

AppsClient is the microsoft Azure Mobile Engagement REST APIs.

func NewAppsClient 

func NewAppsClient(subscriptionID string, resourceGroupName string, appCollection string, appName string) AppsClient

NewAppsClient creates an instance of the AppsClient client.

func NewAppsClientWithBaseURI 

func NewAppsClientWithBaseURI(baseURI string, subscriptionID string, resourceGroupName string, appCollection string, appName string) AppsClient

NewAppsClientWithBaseURI creates an instance of the AppsClient client.

func (AppsClient) List 

func (client AppsClient) List() (result AppListResult, err error)

List lists apps in an appCollection.

func (AppsClient) ListNextResults 

func (client AppsClient) ListNextResults(lastResults AppListResult) (result AppListResult, err error)

ListNextResults retrieves the next set of results, if any.

func (AppsClient) ListPreparer 

func (client AppsClient) ListPreparer() (*http.Request, error)

ListPreparer prepares the List request.

func (AppsClient) ListResponder 

func (client AppsClient) ListResponder(resp *http.Response) (result AppListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (AppsClient) ListSender 

func (client AppsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type AudienceOperators 

type AudienceOperators string

AudienceOperators enumerates the values for audience operators. 

const (
	// EQ specifies the eq state for audience operators.
	EQ AudienceOperators = "EQ"
	// GE specifies the ge state for audience operators.
	GE AudienceOperators = "GE"
	// GT specifies the gt state for audience operators.
	GT AudienceOperators = "GT"
	// LE specifies the le state for audience operators.
	LE AudienceOperators = "LE"
	// LT specifies the lt state for audience operators.
	LT AudienceOperators = "LT"
)

type BooleanTagCriterion 

type BooleanTagCriterion struct {
	Name  *string `json:"name,omitempty"`
	Value *bool   `json:"value,omitempty"`
}

BooleanTagCriterion is target devices based on a boolean tag value.

type Campaign 

type Campaign struct {
	NotificationTitle     *string                           `json:"notificationTitle,omitempty"`
	NotificationMessage   *string                           `json:"notificationMessage,omitempty"`
	NotificationImage     *[]byte                           `json:"notificationImage,omitempty"`
	NotificationOptions   *NotificationOptions              `json:"notificationOptions,omitempty"`
	Title                 *string                           `json:"title,omitempty"`
	Body                  *string                           `json:"body,omitempty"`
	ActionButtonText      *string                           `json:"actionButtonText,omitempty"`
	ExitButtonText        *string                           `json:"exitButtonText,omitempty"`
	ActionURL             *string                           `json:"actionUrl,omitempty"`
	Payload               *map[string]interface{}           `json:"payload,omitempty"`
	Name                  *string                           `json:"name,omitempty"`
	Audience              *CampaignAudience                 `json:"audience,omitempty"`
	Category              *string                           `json:"category,omitempty"`
	PushMode              PushModes                         `json:"pushMode,omitempty"`
	Type                  CampaignTypes                     `json:"type,omitempty"`
	DeliveryTime          DeliveryTimes                     `json:"deliveryTime,omitempty"`
	DeliveryActivities    *[]string                         `json:"deliveryActivities,omitempty"`
	StartTime             *string                           `json:"startTime,omitempty"`
	EndTime               *string                           `json:"endTime,omitempty"`
	Timezone              *string                           `json:"timezone,omitempty"`
	NotificationType      NotificationTypes                 `json:"notificationType,omitempty"`
	NotificationIcon      *bool                             `json:"notificationIcon,omitempty"`
	NotificationCloseable *bool                             `json:"notificationCloseable,omitempty"`
	NotificationVibrate   *bool                             `json:"notificationVibrate,omitempty"`
	NotificationSound     *bool                             `json:"notificationSound,omitempty"`
	NotificationBadge     *bool                             `json:"notificationBadge,omitempty"`
	Localization          *map[string]*CampaignLocalization `json:"localization,omitempty"`
	Questions             *[]PollQuestion                   `json:"questions,omitempty"`
}

Campaign is

type CampaignAudience 

type CampaignAudience struct {
	Expression *string                `json:"expression,omitempty"`
	Criteria   *map[string]*Criterion `json:"criteria,omitempty"`
	Filters    *[]Filter              `json:"filters,omitempty"`
}

CampaignAudience is specify which users will be targeted by this campaign. By default, all users will be targeted. If you set `pushMode` property to `manual`, the only thing you can specify in the audience is the push quota filter. An audience is a boolean expression made of criteria (variables) operators (`not`, `and` or `or`) and parenthesis. Additionally, a set of filters can be added to an audience. 65535 bytes max as per JSON encoding.

type CampaignFeedbacks 

type CampaignFeedbacks string

CampaignFeedbacks enumerates the values for campaign feedbacks. 

const (
	// Actioned specifies the actioned state for campaign feedbacks.
	Actioned CampaignFeedbacks = "actioned"
	// Exited specifies the exited state for campaign feedbacks.
	Exited CampaignFeedbacks = "exited"
	// Pushed specifies the pushed state for campaign feedbacks.
	Pushed CampaignFeedbacks = "pushed"
	// Replied specifies the replied state for campaign feedbacks.
	Replied CampaignFeedbacks = "replied"
)

type CampaignKinds 

type CampaignKinds string

CampaignKinds enumerates the values for campaign kinds. 

const (
	// Announcements specifies the announcements state for campaign kinds.
	Announcements CampaignKinds = "announcements"
	// DataPushes specifies the data pushes state for campaign kinds.
	DataPushes CampaignKinds = "dataPushes"
	// NativePushes specifies the native pushes state for campaign kinds.
	NativePushes CampaignKinds = "nativePushes"
	// Polls specifies the polls state for campaign kinds.
	Polls CampaignKinds = "polls"
)

type CampaignListResult 

type CampaignListResult struct {
	State         CampaignStates `json:"state,omitempty"`
	ID            *int32         `json:"id,omitempty"`
	Name          *string        `json:"name,omitempty"`
	ActivatedDate *date.Time     `json:"activatedDate,omitempty"`
	FinishedDate  *date.Time     `json:"finishedDate,omitempty"`
	StartTime     *date.Time     `json:"startTime,omitempty"`
	EndTime       *date.Time     `json:"endTime,omitempty"`
	Timezone      *string        `json:"timezone,omitempty"`
}

CampaignListResult is

type CampaignLocalization 

type CampaignLocalization struct {
	NotificationTitle   *string                 `json:"notificationTitle,omitempty"`
	NotificationMessage *string                 `json:"notificationMessage,omitempty"`
	NotificationImage   *[]byte                 `json:"notificationImage,omitempty"`
	NotificationOptions *NotificationOptions    `json:"notificationOptions,omitempty"`
	Title               *string                 `json:"title,omitempty"`
	Body                *string                 `json:"body,omitempty"`
	ActionButtonText    *string                 `json:"actionButtonText,omitempty"`
	ExitButtonText      *string                 `json:"exitButtonText,omitempty"`
	ActionURL           *string                 `json:"actionUrl,omitempty"`
	Payload             *map[string]interface{} `json:"payload,omitempty"`
}

CampaignLocalization is

type CampaignPushParameters 

type CampaignPushParameters struct {
	DeviceIds *[]string `json:"deviceIds,omitempty"`
	Data      *Campaign `json:"data,omitempty"`
}

CampaignPushParameters is

type CampaignPushResult 

type CampaignPushResult struct {
	autorest.Response `json:"-"`
	InvalidDeviceIds  *[]string `json:"invalidDeviceIds,omitempty"`
}

CampaignPushResult is

type CampaignResult 

type CampaignResult struct {
	autorest.Response     `json:"-"`
	NotificationTitle     *string                           `json:"notificationTitle,omitempty"`
	NotificationMessage   *string                           `json:"notificationMessage,omitempty"`
	NotificationImage     *[]byte                           `json:"notificationImage,omitempty"`
	NotificationOptions   *NotificationOptions              `json:"notificationOptions,omitempty"`
	Title                 *string                           `json:"title,omitempty"`
	Body                  *string                           `json:"body,omitempty"`
	ActionButtonText      *string                           `json:"actionButtonText,omitempty"`
	ExitButtonText        *string                           `json:"exitButtonText,omitempty"`
	ActionURL             *string                           `json:"actionUrl,omitempty"`
	Payload               *map[string]interface{}           `json:"payload,omitempty"`
	Name                  *string                           `json:"name,omitempty"`
	Audience              *CampaignAudience                 `json:"audience,omitempty"`
	Category              *string                           `json:"category,omitempty"`
	PushMode              PushModes                         `json:"pushMode,omitempty"`
	Type                  CampaignTypes                     `json:"type,omitempty"`
	DeliveryTime          DeliveryTimes                     `json:"deliveryTime,omitempty"`
	DeliveryActivities    *[]string                         `json:"deliveryActivities,omitempty"`
	StartTime             *string                           `json:"startTime,omitempty"`
	EndTime               *string                           `json:"endTime,omitempty"`
	Timezone              *string                           `json:"timezone,omitempty"`
	NotificationType      NotificationTypes                 `json:"notificationType,omitempty"`
	NotificationIcon      *bool                             `json:"notificationIcon,omitempty"`
	NotificationCloseable *bool                             `json:"notificationCloseable,omitempty"`
	NotificationVibrate   *bool                             `json:"notificationVibrate,omitempty"`
	NotificationSound     *bool                             `json:"notificationSound,omitempty"`
	NotificationBadge     *bool                             `json:"notificationBadge,omitempty"`
	Localization          *map[string]*CampaignLocalization `json:"localization,omitempty"`
	Questions             *[]PollQuestion                   `json:"questions,omitempty"`
	ID                    *int32                            `json:"id,omitempty"`
	State                 CampaignStates                    `json:"state,omitempty"`
	ActivatedDate         *date.Time                        `json:"activatedDate,omitempty"`
	FinishedDate          *date.Time                        `json:"finishedDate,omitempty"`
}

CampaignResult is

type CampaignState 

type CampaignState struct {
	autorest.Response `json:"-"`
	State             CampaignStates `json:"state,omitempty"`
}

CampaignState is

type CampaignStateResult 

type CampaignStateResult struct {
	autorest.Response `json:"-"`
	State             CampaignStates `json:"state,omitempty"`
	ID                *int32         `json:"id,omitempty"`
}

CampaignStateResult is

type CampaignStates 

type CampaignStates string

CampaignStates enumerates the values for campaign states. 

const (
	// Draft specifies the draft state for campaign states.
	Draft CampaignStates = "draft"
	// Finished specifies the finished state for campaign states.
	Finished CampaignStates = "finished"
	// InProgress specifies the in progress state for campaign states.
	InProgress CampaignStates = "in-progress"
	// Queued specifies the queued state for campaign states.
	Queued CampaignStates = "queued"
	// Scheduled specifies the scheduled state for campaign states.
	Scheduled CampaignStates = "scheduled"
)

type CampaignStatisticsResult 

type CampaignStatisticsResult struct {
	autorest.Response           `json:"-"`
	Queued                      *int32                             `json:"queued,omitempty"`
	Pushed                      *int32                             `json:"pushed,omitempty"`
	PushedNative                *int32                             `json:"pushed-native,omitempty"`
	PushedNativeGoogle          *int32                             `json:"pushed-native-google,omitempty"`
	PushedNativeAdm             *int32                             `json:"pushed-native-adm,omitempty"`
	Delivered                   *int32                             `json:"delivered,omitempty"`
	Dropped                     *int32                             `json:"dropped,omitempty"`
	SystemNotificationDisplayed *int32                             `json:"system-notification-displayed,omitempty"`
	InAppNotificationDisplayed  *int32                             `json:"in-app-notification-displayed,omitempty"`
	ContentDisplayed            *int32                             `json:"content-displayed,omitempty"`
	SystemNotificationActioned  *int32                             `json:"system-notification-actioned,omitempty"`
	SystemNotificationExited    *int32                             `json:"system-notification-exited,omitempty"`
	InAppNotificationActioned   *int32                             `json:"in-app-notification-actioned,omitempty"`
	InAppNotificationExited     *int32                             `json:"in-app-notification-exited,omitempty"`
	ContentActioned             *int32                             `json:"content-actioned,omitempty"`
	ContentExited               *int32                             `json:"content-exited,omitempty"`
	Answers                     *map[string]map[string]interface{} `json:"answers,omitempty"`
}

CampaignStatisticsResult is

type CampaignTestNewParameters 

type CampaignTestNewParameters struct {
	DeviceID *string   `json:"deviceId,omitempty"`
	Lang     *string   `json:"lang,omitempty"`
	Data     *Campaign `json:"data,omitempty"`
}

CampaignTestNewParameters is

type CampaignTestSavedParameters 

type CampaignTestSavedParameters struct {
	DeviceID *string `json:"deviceId,omitempty"`
	Lang     *string `json:"lang,omitempty"`
}

CampaignTestSavedParameters is

type CampaignType 

type CampaignType string

CampaignType enumerates the values for campaign type. 

const (
	// Announcement specifies the announcement state for campaign type.
	Announcement CampaignType = "Announcement"
	// DataPush specifies the data push state for campaign type.
	DataPush CampaignType = "DataPush"
	// NativePush specifies the native push state for campaign type.
	NativePush CampaignType = "NativePush"
	// Poll specifies the poll state for campaign type.
	Poll CampaignType = "Poll"
)

type CampaignTypes 

type CampaignTypes string

CampaignTypes enumerates the values for campaign types. 

const (
	// OnlyNotif specifies the only notif state for campaign types.
	OnlyNotif CampaignTypes = "only_notif"
	// Textbase64 specifies the textbase 64 state for campaign types.
	Textbase64 CampaignTypes = "text/base64"
	// Texthtml specifies the texthtml state for campaign types.
	Texthtml CampaignTypes = "text/html"
	// Textplain specifies the textplain state for campaign types.
	Textplain CampaignTypes = "text/plain"
)

type CampaignsClient 

type CampaignsClient struct {
	ManagementClient
}

CampaignsClient is the microsoft Azure Mobile Engagement REST APIs.

func NewCampaignsClient 

func NewCampaignsClient(subscriptionID string, resourceGroupName string, appCollection string, appName string) CampaignsClient

NewCampaignsClient creates an instance of the CampaignsClient client.

func NewCampaignsClientWithBaseURI 

func NewCampaignsClientWithBaseURI(baseURI string, subscriptionID string, resourceGroupName string, appCollection string, appName string) CampaignsClient

NewCampaignsClientWithBaseURI creates an instance of the CampaignsClient client.

func (CampaignsClient) Activate 

func (client CampaignsClient) Activate(kind CampaignKinds, id int32) (result CampaignStateResult, err error)

Activate activate a campaign previously created by a call to Create campaign.

kind is campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' id is campaign identifier.

func (CampaignsClient) ActivatePreparer 

func (client CampaignsClient) ActivatePreparer(kind CampaignKinds, id int32) (*http.Request, error)

ActivatePreparer prepares the Activate request.

func (CampaignsClient) ActivateResponder 

func (client CampaignsClient) ActivateResponder(resp *http.Response) (result CampaignStateResult, err error)

ActivateResponder handles the response to the Activate request. The method always closes the http.Response Body.

func (CampaignsClient) ActivateSender 

func (client CampaignsClient) ActivateSender(req *http.Request) (*http.Response, error)

ActivateSender sends the Activate request. The method will close the http.Response Body if it receives an error.

func (CampaignsClient) Create 

func (client CampaignsClient) Create(kind CampaignKinds, parameters Campaign) (result CampaignStateResult, err error)

Create create a push campaign (announcement, poll, data push or native push).

kind is campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' parameters is parameters supplied to the Update Campaign operation.

func (CampaignsClient) CreatePreparer 

func (client CampaignsClient) CreatePreparer(kind CampaignKinds, parameters Campaign) (*http.Request, error)

CreatePreparer prepares the Create request.

func (CampaignsClient) CreateResponder 

func (client CampaignsClient) CreateResponder(resp *http.Response) (result CampaignStateResult, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (CampaignsClient) CreateSender 

func (client CampaignsClient) CreateSender(req *http.Request) (*http.Response, error)

CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.

func (CampaignsClient) Delete 

func (client CampaignsClient) Delete(kind CampaignKinds, id int32) (result autorest.Response, err error)

Delete delete a campaign previously created by a call to Create campaign.

kind is campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' id is campaign identifier.

func (CampaignsClient) DeletePreparer 

func (client CampaignsClient) DeletePreparer(kind CampaignKinds, id int32) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (CampaignsClient) DeleteResponder 

func (client CampaignsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (CampaignsClient) DeleteSender 

func (client CampaignsClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (CampaignsClient) Finish 

func (client CampaignsClient) Finish(kind CampaignKinds, id int32) (result CampaignStateResult, err error)

Finish finish a push campaign previously activated by a call to Activate campaign.

kind is campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' id is campaign identifier.

func (CampaignsClient) FinishPreparer 

func (client CampaignsClient) FinishPreparer(kind CampaignKinds, id int32) (*http.Request, error)

FinishPreparer prepares the Finish request.

func (CampaignsClient) FinishResponder 

func (client CampaignsClient) FinishResponder(resp *http.Response) (result CampaignStateResult, err error)

FinishResponder handles the response to the Finish request. The method always closes the http.Response Body.

func (CampaignsClient) FinishSender 

func (client CampaignsClient) FinishSender(req *http.Request) (*http.Response, error)

FinishSender sends the Finish request. The method will close the http.Response Body if it receives an error.

func (CampaignsClient) Get 

func (client CampaignsClient) Get(kind CampaignKinds, id int32) (result CampaignResult, err error)

Get the Get campaign operation retrieves information about a previously created campaign.

kind is campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' id is campaign identifier.

func (CampaignsClient) GetByName 

func (client CampaignsClient) GetByName(kind CampaignKinds, name string) (result CampaignResult, err error)

GetByName the Get campaign operation retrieves information about a previously created campaign.

kind is campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' name is campaign name.

func (CampaignsClient) GetByNamePreparer 

func (client CampaignsClient) GetByNamePreparer(kind CampaignKinds, name string) (*http.Request, error)

GetByNamePreparer prepares the GetByName request.

func (CampaignsClient) GetByNameResponder 

func (client CampaignsClient) GetByNameResponder(resp *http.Response) (result CampaignResult, err error)

GetByNameResponder handles the response to the GetByName request. The method always closes the http.Response Body.

func (CampaignsClient) GetByNameSender 

func (client CampaignsClient) GetByNameSender(req *http.Request) (*http.Response, error)

GetByNameSender sends the GetByName request. The method will close the http.Response Body if it receives an error.

func (CampaignsClient) GetPreparer 

func (client CampaignsClient) GetPreparer(kind CampaignKinds, id int32) (*http.Request, error)

GetPreparer prepares the Get request.

func (CampaignsClient) GetResponder 

func (client CampaignsClient) GetResponder(resp *http.Response) (result CampaignResult, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (CampaignsClient) GetSender 

func (client CampaignsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (CampaignsClient) GetStatistics 

func (client CampaignsClient) GetStatistics(kind CampaignKinds, id int32) (result CampaignStatisticsResult, err error)

GetStatistics get all the campaign statistics.

kind is campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' id is campaign identifier.

func (CampaignsClient) GetStatisticsPreparer 

func (client CampaignsClient) GetStatisticsPreparer(kind CampaignKinds, id int32) (*http.Request, error)

GetStatisticsPreparer prepares the GetStatistics request.

func (CampaignsClient) GetStatisticsResponder 

func (client CampaignsClient) GetStatisticsResponder(resp *http.Response) (result CampaignStatisticsResult, err error)

GetStatisticsResponder handles the response to the GetStatistics request. The method always closes the http.Response Body.

func (CampaignsClient) GetStatisticsSender 

func (client CampaignsClient) GetStatisticsSender(req *http.Request) (*http.Response, error)

GetStatisticsSender sends the GetStatistics request. The method will close the http.Response Body if it receives an error.

func (CampaignsClient) List 

func (client CampaignsClient) List(kind CampaignKinds, skip *int32, top *int32, filter string, orderby string, search string) (result CampaignsListResult, err error)

List get the list of campaigns.

kind is campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' skip is control paging of campaigns, start results at the given offset, defaults to 0 (1st page of data). top is control paging of campaigns, number of campaigns to return with each call. It returns all campaigns by default. When specifying $top parameter, the response contains a `nextLink` property describing the path to get the next page if there are more results. filter is filter can be used to restrict the results to campaigns matching a specific state. The syntax is `$filter=state eq 'draft'`. Valid state values are: draft, scheduled, in-progress, and finished. Only the eq operator and the state property are supported. orderby is sort results by an expression which looks like `$orderby=id asc` (this example is actually the default behavior). The syntax is orderby={property} {direction} or just orderby={property}. The available sorting properties are id, name, state, activatedDate, and finishedDate. The available directions are asc (for ascending order) and desc (for descending order). When not specified the asc direction is used. Only one property at a time can be used for sorting. search is restrict results to campaigns matching the optional `search` expression. This currently performs the search based on the name on the campaign only, case insensitive. If the campaign contains the value of the `search` parameter anywhere in the name, it matches.

func (CampaignsClient) ListNextResults 

func (client CampaignsClient) ListNextResults(lastResults CampaignsListResult) (result CampaignsListResult, err error)

ListNextResults retrieves the next set of results, if any.

func (CampaignsClient) ListPreparer 

func (client CampaignsClient) ListPreparer(kind CampaignKinds, skip *int32, top *int32, filter string, orderby string, search string) (*http.Request, error)

ListPreparer prepares the List request.

func (CampaignsClient) ListResponder 

func (client CampaignsClient) ListResponder(resp *http.Response) (result CampaignsListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (CampaignsClient) ListSender 

func (client CampaignsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (CampaignsClient) Push 

func (client CampaignsClient) Push(kind CampaignKinds, id int32, parameters CampaignPushParameters) (result CampaignPushResult, err error)

Push push a previously saved campaign (created with Create campaign) to a set of devices.

kind is campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' id is campaign identifier. parameters is parameters supplied to the Push Campaign operation.

func (CampaignsClient) PushPreparer 

func (client CampaignsClient) PushPreparer(kind CampaignKinds, id int32, parameters CampaignPushParameters) (*http.Request, error)

PushPreparer prepares the Push request.

func (CampaignsClient) PushResponder 

func (client CampaignsClient) PushResponder(resp *http.Response) (result CampaignPushResult, err error)

PushResponder handles the response to the Push request. The method always closes the http.Response Body.

func (CampaignsClient) PushSender 

func (client CampaignsClient) PushSender(req *http.Request) (*http.Response, error)

PushSender sends the Push request. The method will close the http.Response Body if it receives an error.

func (CampaignsClient) Suspend 

func (client CampaignsClient) Suspend(kind CampaignKinds, id int32) (result CampaignStateResult, err error)

Suspend suspend a push campaign previously activated by a call to Activate campaign.

kind is campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' id is campaign identifier.

func (CampaignsClient) SuspendPreparer 

func (client CampaignsClient) SuspendPreparer(kind CampaignKinds, id int32) (*http.Request, error)

SuspendPreparer prepares the Suspend request.

func (CampaignsClient) SuspendResponder 

func (client CampaignsClient) SuspendResponder(resp *http.Response) (result CampaignStateResult, err error)

SuspendResponder handles the response to the Suspend request. The method always closes the http.Response Body.

func (CampaignsClient) SuspendSender 

func (client CampaignsClient) SuspendSender(req *http.Request) (*http.Response, error)

SuspendSender sends the Suspend request. The method will close the http.Response Body if it receives an error.

func (CampaignsClient) TestNew 

func (client CampaignsClient) TestNew(kind CampaignKinds, parameters CampaignTestNewParameters) (result CampaignState, err error)

TestNew test a new campaign on a set of devices.

kind is campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' parameters is parameters supplied to the Test Campaign operation.

func (CampaignsClient) TestNewPreparer 

func (client CampaignsClient) TestNewPreparer(kind CampaignKinds, parameters CampaignTestNewParameters) (*http.Request, error)

TestNewPreparer prepares the TestNew request.

func (CampaignsClient) TestNewResponder 

func (client CampaignsClient) TestNewResponder(resp *http.Response) (result CampaignState, err error)

TestNewResponder handles the response to the TestNew request. The method always closes the http.Response Body.

func (CampaignsClient) TestNewSender 

func (client CampaignsClient) TestNewSender(req *http.Request) (*http.Response, error)

TestNewSender sends the TestNew request. The method will close the http.Response Body if it receives an error.

func (CampaignsClient) TestSaved 

func (client CampaignsClient) TestSaved(kind CampaignKinds, id int32, parameters CampaignTestSavedParameters) (result CampaignStateResult, err error)

TestSaved test an existing campaign (created with Create campaign) on a set of devices.

kind is campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' id is campaign identifier. parameters is parameters supplied to the Test Campaign operation.

func (CampaignsClient) TestSavedPreparer 

func (client CampaignsClient) TestSavedPreparer(kind CampaignKinds, id int32, parameters CampaignTestSavedParameters) (*http.Request, error)

TestSavedPreparer prepares the TestSaved request.

func (CampaignsClient) TestSavedResponder 

func (client CampaignsClient) TestSavedResponder(resp *http.Response) (result CampaignStateResult, err error)

TestSavedResponder handles the response to the TestSaved request. The method always closes the http.Response Body.

func (CampaignsClient) TestSavedSender 

func (client CampaignsClient) TestSavedSender(req *http.Request) (*http.Response, error)

TestSavedSender sends the TestSaved request. The method will close the http.Response Body if it receives an error.

func (CampaignsClient) Update 

func (client CampaignsClient) Update(kind CampaignKinds, id int32, parameters Campaign) (result CampaignStateResult, err error)

Update update an existing push campaign (announcement, poll, data push or native push).

kind is campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' id is campaign identifier. parameters is parameters supplied to the Update Campaign operation.

func (CampaignsClient) UpdatePreparer 

func (client CampaignsClient) UpdatePreparer(kind CampaignKinds, id int32, parameters Campaign) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (CampaignsClient) UpdateResponder 

func (client CampaignsClient) UpdateResponder(resp *http.Response) (result CampaignStateResult, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (CampaignsClient) UpdateSender 

func (client CampaignsClient) UpdateSender(req *http.Request) (*http.Response, error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type CampaignsListResult 

type CampaignsListResult struct {
	autorest.Response `json:"-"`
	Value             *[]CampaignListResult `json:"value,omitempty"`
	NextLink          *string               `json:"nextLink,omitempty"`
}

CampaignsListResult is the campaigns list result.

func (CampaignsListResult) CampaignsListResultPreparer 

func (client CampaignsListResult) CampaignsListResultPreparer() (*http.Request, error)

CampaignsListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type CarrierCountryCriterion 

type CarrierCountryCriterion struct {
	Name *string `json:"name,omitempty"`
}

CarrierCountryCriterion is used to target devices based on their carrier country.

type CarrierNameCriterion 

type CarrierNameCriterion struct {
	Name *string `json:"name,omitempty"`
}

CarrierNameCriterion is used to target devices based on their carrier name.

type Criterion 

type Criterion struct {
}

Criterion is

type DatapushFeedbackCriterion 

type DatapushFeedbackCriterion struct {
	ContentID *int32            `json:"content-id,omitempty"`
	Action    CampaignFeedbacks `json:"action,omitempty"`
}

DatapushFeedbackCriterion is used to target devices who received a data push.

type DateRangeExportTaskParameter 

type DateRangeExportTaskParameter struct {
	ContainerURL *string      `json:"containerUrl,omitempty"`
	Description  *string      `json:"description,omitempty"`
	StartDate    *date.Date   `json:"startDate,omitempty"`
	EndDate      *date.Date   `json:"endDate,omitempty"`
	ExportFormat ExportFormat `json:"exportFormat,omitempty"`
}

DateRangeExportTaskParameter is

type DateTagCriterion 

type DateTagCriterion struct {
	Name  *string           `json:"name,omitempty"`
	Value *date.Date        `json:"value,omitempty"`
	Op    AudienceOperators `json:"op,omitempty"`
}

DateTagCriterion is target devices based on a date tag value.

type DeliveryTimes 

type DeliveryTimes string

DeliveryTimes enumerates the values for delivery times. 

const (
	// Any specifies the any state for delivery times.
	Any DeliveryTimes = "any"
	// Background specifies the background state for delivery times.
	Background DeliveryTimes = "background"
	// Session specifies the session state for delivery times.
	Session DeliveryTimes = "session"
)

type Device 

type Device struct {
	autorest.Response `json:"-"`
	DeviceID          *string             `json:"deviceId,omitempty"`
	Meta              *DeviceMeta         `json:"meta,omitempty"`
	Info              *DeviceInfo         `json:"info,omitempty"`
	Location          *DeviceLocation     `json:"location,omitempty"`
	AppInfo           *map[string]*string `json:"appInfo,omitempty"`
}

Device is

type DeviceInfo 

type DeviceInfo struct {
	PhoneModel             *string `json:"phoneModel,omitempty"`
	PhoneManufacturer      *string `json:"phoneManufacturer,omitempty"`
	FirmwareVersion        *string `json:"firmwareVersion,omitempty"`
	FirmwareName           *string `json:"firmwareName,omitempty"`
	AndroidAPILevel        *int32  `json:"androidAPILevel,omitempty"`
	CarrierCountry         *string `json:"carrierCountry,omitempty"`
	Locale                 *string `json:"locale,omitempty"`
	CarrierName            *string `json:"carrierName,omitempty"`
	NetworkType            *string `json:"networkType,omitempty"`
	NetworkSubtype         *string `json:"networkSubtype,omitempty"`
	ApplicationVersionName *string `json:"applicationVersionName,omitempty"`
	ApplicationVersionCode *int32  `json:"applicationVersionCode,omitempty"`
	TimeZoneOffset         *int32  `json:"timeZoneOffset,omitempty"`
	ServiceVersion         *string `json:"serviceVersion,omitempty"`
}

DeviceInfo is

type DeviceLocation 

type DeviceLocation struct {
	Countrycode *string `json:"countrycode,omitempty"`
	Region      *string `json:"region,omitempty"`
	Locality    *string `json:"locality,omitempty"`
}

DeviceLocation is

type DeviceManufacturerCriterion 

type DeviceManufacturerCriterion struct {
	Name *string `json:"name,omitempty"`
}

DeviceManufacturerCriterion is used to target devices based on the device manufacturer.

type DeviceMeta 

type DeviceMeta struct {
	FirstSeen         *int64 `json:"firstSeen,omitempty"`
	LastSeen          *int64 `json:"lastSeen,omitempty"`
	LastInfo          *int64 `json:"lastInfo,omitempty"`
	LastLocation      *int64 `json:"lastLocation,omitempty"`
	NativePushEnabled *bool  `json:"nativePushEnabled,omitempty"`
}

DeviceMeta is

type DeviceModelCriterion 

type DeviceModelCriterion struct {
	Name *string `json:"name,omitempty"`
}

DeviceModelCriterion is used to target devices based on the device model.

type DeviceQueryResult 

type DeviceQueryResult struct {
	DeviceID *string             `json:"deviceId,omitempty"`
	Meta     *DeviceMeta         `json:"meta,omitempty"`
	AppInfo  *map[string]*string `json:"appInfo,omitempty"`
}

DeviceQueryResult is

type DeviceTagsParameters 

type DeviceTagsParameters struct {
	Tags         *map[string]map[string]string `json:"tags,omitempty"`
	DeleteOnNull *bool                         `json:"deleteOnNull,omitempty"`
}

DeviceTagsParameters is

type DeviceTagsResult 

type DeviceTagsResult struct {
	autorest.Response `json:"-"`
	InvalidIds        *[]string `json:"invalidIds,omitempty"`
}

DeviceTagsResult is

type DevicesClient 

type DevicesClient struct {
	ManagementClient
}

DevicesClient is the microsoft Azure Mobile Engagement REST APIs.

func NewDevicesClient 

func NewDevicesClient(subscriptionID string, resourceGroupName string, appCollection string, appName string) DevicesClient

NewDevicesClient creates an instance of the DevicesClient client.

func NewDevicesClientWithBaseURI 

func NewDevicesClientWithBaseURI(baseURI string, subscriptionID string, resourceGroupName string, appCollection string, appName string) DevicesClient

NewDevicesClientWithBaseURI creates an instance of the DevicesClient client.

func (DevicesClient) GetByDeviceID 

func (client DevicesClient) GetByDeviceID(deviceID string) (result Device, err error)

GetByDeviceID get the information associated to a device running an application.

deviceID is device identifier.

func (DevicesClient) GetByDeviceIDPreparer 

func (client DevicesClient) GetByDeviceIDPreparer(deviceID string) (*http.Request, error)

GetByDeviceIDPreparer prepares the GetByDeviceID request.

func (DevicesClient) GetByDeviceIDResponder 

func (client DevicesClient) GetByDeviceIDResponder(resp *http.Response) (result Device, err error)

GetByDeviceIDResponder handles the response to the GetByDeviceID request. The method always closes the http.Response Body.

func (DevicesClient) GetByDeviceIDSender 

func (client DevicesClient) GetByDeviceIDSender(req *http.Request) (*http.Response, error)

GetByDeviceIDSender sends the GetByDeviceID request. The method will close the http.Response Body if it receives an error.

func (DevicesClient) GetByUserID 

func (client DevicesClient) GetByUserID(userID string) (result Device, err error)

GetByUserID get the information associated to a device running an application using the user identifier.

userID is user identifier.

func (DevicesClient) GetByUserIDPreparer 

func (client DevicesClient) GetByUserIDPreparer(userID string) (*http.Request, error)

GetByUserIDPreparer prepares the GetByUserID request.

func (DevicesClient) GetByUserIDResponder 

func (client DevicesClient) GetByUserIDResponder(resp *http.Response) (result Device, err error)

GetByUserIDResponder handles the response to the GetByUserID request. The method always closes the http.Response Body.

func (DevicesClient) GetByUserIDSender 

func (client DevicesClient) GetByUserIDSender(req *http.Request) (*http.Response, error)

GetByUserIDSender sends the GetByUserID request. The method will close the http.Response Body if it receives an error.

func (DevicesClient) List 

func (client DevicesClient) List(top *int32, selectParameter string, filter string) (result DevicesQueryResult, err error)

List query the information associated to the devices running an application.

top is number of devices to return with each call. Defaults to 100 and cannot return more. Passing a greater value is ignored. The response contains a `nextLink` property describing the URI path to get the next page of results if not all results could be returned at once. selectParameter is by default all `meta` and `appInfo` properties are returned, this property is used to restrict the output to the desired properties. It also excludes all devices from the output that have none of the selected properties. In other terms, only devices having at least one of the selected property being set is part of the results. Examples: - `$select=appInfo` : select all devices having at least 1 appInfo, return them all and don’t return any meta property. - `$select=meta` : return only meta properties in the output. - `$select=appInfo,meta/firstSeen,meta/lastSeen` : return all `appInfo`, plus meta object containing only firstSeen and lastSeen properties. The format is thus a comma separated list of properties to select. Use `appInfo` to select all appInfo properties, `meta` to select all meta properties. Use `appInfo/{key}` and `meta/{key}` to select specific appInfo and meta properties. filter is filter can be used to reduce the number of results. Filter is a boolean expression that can look like the following examples: * `$filter=deviceId gt 'abcdef0123456789abcdef0123456789'` * `$filter=lastModified le 1447284263690L` * `$filter=(deviceId ge 'abcdef0123456789abcdef0123456789') and (deviceId lt 'bacdef0123456789abcdef0123456789') and (lastModified gt 1447284263690L)` The first example is used automatically for paging when returning the `nextLink` property. The filter expression is a combination of checks on some properties that can be compared to their value. The available operators are: * `gt` : greater than * `ge` : greater than or equals * `lt` : less than * `le` : less than or equals * `and` : to add multiple checks (all checks must pass), optional parentheses can be used. The properties that can be used in the expression are the following: * `deviceId {operator} '{deviceIdValue}'` : a lexicographical comparison is made on the deviceId value, use single quotes for the value. * `lastModified {operator} {number}L` : returns only meta properties or appInfo properties whose last value modification timestamp compared to the specified value is matching (value is milliseconds since January 1st, 1970 UTC). Please note the `L` character after the number of milliseconds, its required when the number of milliseconds exceeds `2^31 - 1` (which is always the case for recent timestamps). Using `lastModified` excludes all devices from the output that have no property matching the timestamp criteria, like `$select`. Please note that the internal value of `lastModified` timestamp for a given property is never part of the results.

func (DevicesClient) ListNextResults 

func (client DevicesClient) ListNextResults(lastResults DevicesQueryResult) (result DevicesQueryResult, err error)

ListNextResults retrieves the next set of results, if any.

func (DevicesClient) ListPreparer 

func (client DevicesClient) ListPreparer(top *int32, selectParameter string, filter string) (*http.Request, error)

ListPreparer prepares the List request.

func (DevicesClient) ListResponder 

func (client DevicesClient) ListResponder(resp *http.Response) (result DevicesQueryResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (DevicesClient) ListSender 

func (client DevicesClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (DevicesClient) TagByDeviceID 

func (client DevicesClient) TagByDeviceID(parameters DeviceTagsParameters) (result DeviceTagsResult, err error)

TagByDeviceID update the tags registered for a set of devices running an application. Updates are performed asynchronously, meaning that a few seconds are needed before the modifications appear in the results of the Get device command.

func (DevicesClient) TagByDeviceIDPreparer 

func (client DevicesClient) TagByDeviceIDPreparer(parameters DeviceTagsParameters) (*http.Request, error)

TagByDeviceIDPreparer prepares the TagByDeviceID request.

func (DevicesClient) TagByDeviceIDResponder 

func (client DevicesClient) TagByDeviceIDResponder(resp *http.Response) (result DeviceTagsResult, err error)

TagByDeviceIDResponder handles the response to the TagByDeviceID request. The method always closes the http.Response Body.

func (DevicesClient) TagByDeviceIDSender 

func (client DevicesClient) TagByDeviceIDSender(req *http.Request) (*http.Response, error)

TagByDeviceIDSender sends the TagByDeviceID request. The method will close the http.Response Body if it receives an error.

func (DevicesClient) TagByUserID 

func (client DevicesClient) TagByUserID(parameters DeviceTagsParameters) (result DeviceTagsResult, err error)

TagByUserID update the tags registered for a set of users running an application. Updates are performed asynchronously, meaning that a few seconds are needed before the modifications appear in the results of the Get device command.

func (DevicesClient) TagByUserIDPreparer 

func (client DevicesClient) TagByUserIDPreparer(parameters DeviceTagsParameters) (*http.Request, error)

TagByUserIDPreparer prepares the TagByUserID request.

func (DevicesClient) TagByUserIDResponder 

func (client DevicesClient) TagByUserIDResponder(resp *http.Response) (result DeviceTagsResult, err error)

TagByUserIDResponder handles the response to the TagByUserID request. The method always closes the http.Response Body.

func (DevicesClient) TagByUserIDSender 

func (client DevicesClient) TagByUserIDSender(req *http.Request) (*http.Response, error)

TagByUserIDSender sends the TagByUserID request. The method will close the http.Response Body if it receives an error.

type DevicesQueryResult 

type DevicesQueryResult struct {
	autorest.Response `json:"-"`
	Value             *[]DeviceQueryResult `json:"value,omitempty"`
	NextLink          *string              `json:"nextLink,omitempty"`
}

DevicesQueryResult is the campaigns list result.

func (DevicesQueryResult) DevicesQueryResultPreparer 

func (client DevicesQueryResult) DevicesQueryResultPreparer() (*http.Request, error)

DevicesQueryResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type EngageActiveUsersFilter 

type EngageActiveUsersFilter struct {
	Threshold *int32 `json:"threshold,omitempty"`
}

EngageActiveUsersFilter is send only to users who have used the app in the last {threshold} days.

type EngageIdleUsersFilter 

type EngageIdleUsersFilter struct {
	Threshold *int32 `json:"threshold,omitempty"`
}

EngageIdleUsersFilter is send only to users who haven't used the app in the last {threshold} days.

type EngageNewUsersFilter 

type EngageNewUsersFilter struct {
	Threshold *int32 `json:"threshold,omitempty"`
}

EngageNewUsersFilter is send only to users whose first app use is less than {threshold} days old.

type EngageOldUsersFilter 

type EngageOldUsersFilter struct {
	Threshold *int32 `json:"threshold,omitempty"`
}

EngageOldUsersFilter is send only to users whose first app use is more than {threshold} days old.

type EngageSubsetFilter 

type EngageSubsetFilter struct {
	Max *int32 `json:"max,omitempty"`
}

EngageSubsetFilter is send only to a maximum of max users.

type ExportFormat 

type ExportFormat string

ExportFormat enumerates the values for export format. 

const (
	// CsvBlob specifies the csv blob state for export format.
	CsvBlob ExportFormat = "CsvBlob"
	// JSONBlob specifies the json blob state for export format.
	JSONBlob ExportFormat = "JsonBlob"
)

type ExportOptions 

type ExportOptions struct {
	ExportUserID *bool `json:"exportUserId,omitempty"`
}

ExportOptions is options to control export generation.

type ExportState 

type ExportState string

ExportState enumerates the values for export state. 

const (
	// ExportStateFailed specifies the export state failed state for export
	// state.
	ExportStateFailed ExportState = "Failed"
	// ExportStateQueued specifies the export state queued state for export
	// state.
	ExportStateQueued ExportState = "Queued"
	// ExportStateStarted specifies the export state started state for export
	// state.
	ExportStateStarted ExportState = "Started"
	// ExportStateSucceeded specifies the export state succeeded state for
	// export state.
	ExportStateSucceeded ExportState = "Succeeded"
)

type ExportTaskListResult 

type ExportTaskListResult struct {
	autorest.Response `json:"-"`
	Value             *[]ExportTaskResult `json:"value,omitempty"`
	NextLink          *string             `json:"nextLink,omitempty"`
}

ExportTaskListResult is gets a paged list of ExportTasks.

func (ExportTaskListResult) ExportTaskListResultPreparer 

func (client ExportTaskListResult) ExportTaskListResultPreparer() (*http.Request, error)

ExportTaskListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type ExportTaskParameter 

type ExportTaskParameter struct {
	ContainerURL *string      `json:"containerUrl,omitempty"`
	Description  *string      `json:"description,omitempty"`
	ExportFormat ExportFormat `json:"exportFormat,omitempty"`
}

ExportTaskParameter is

type ExportTaskResult 

type ExportTaskResult struct {
	autorest.Response `json:"-"`
	ID                *string     `json:"id,omitempty"`
	Description       *string     `json:"description,omitempty"`
	State             ExportState `json:"state,omitempty"`
	DateCreated       *date.Time  `json:"dateCreated,omitempty"`
	DateCompleted     *date.Time  `json:"dateCompleted,omitempty"`
	ExportType        ExportType  `json:"exportType,omitempty"`
	ErrorDetails      *string     `json:"errorDetails,omitempty"`
}

ExportTaskResult is

type ExportTasksClient 

type ExportTasksClient struct {
	ManagementClient
}

ExportTasksClient is the microsoft Azure Mobile Engagement REST APIs.

func NewExportTasksClient 

func NewExportTasksClient(subscriptionID string, resourceGroupName string, appCollection string, appName string) ExportTasksClient

NewExportTasksClient creates an instance of the ExportTasksClient client.

func NewExportTasksClientWithBaseURI 

func NewExportTasksClientWithBaseURI(baseURI string, subscriptionID string, resourceGroupName string, appCollection string, appName string) ExportTasksClient

NewExportTasksClientWithBaseURI creates an instance of the ExportTasksClient client.

func (ExportTasksClient) CreateActivitiesTask 

func (client ExportTasksClient) CreateActivitiesTask(parameters DateRangeExportTaskParameter) (result ExportTaskResult, err error)

CreateActivitiesTask creates a task to export activities.

func (ExportTasksClient) CreateActivitiesTaskPreparer 

func (client ExportTasksClient) CreateActivitiesTaskPreparer(parameters DateRangeExportTaskParameter) (*http.Request, error)

CreateActivitiesTaskPreparer prepares the CreateActivitiesTask request.

func (ExportTasksClient) CreateActivitiesTaskResponder 

func (client ExportTasksClient) CreateActivitiesTaskResponder(resp *http.Response) (result ExportTaskResult, err error)

CreateActivitiesTaskResponder handles the response to the CreateActivitiesTask request. The method always closes the http.Response Body.

func (ExportTasksClient) CreateActivitiesTaskSender 

func (client ExportTasksClient) CreateActivitiesTaskSender(req *http.Request) (*http.Response, error)

CreateActivitiesTaskSender sends the CreateActivitiesTask request. The method will close the http.Response Body if it receives an error.

func (ExportTasksClient) CreateCrashesTask 

func (client ExportTasksClient) CreateCrashesTask(parameters DateRangeExportTaskParameter) (result ExportTaskResult, err error)

CreateCrashesTask creates a task to export crashes.

func (ExportTasksClient) CreateCrashesTaskPreparer 

func (client ExportTasksClient) CreateCrashesTaskPreparer(parameters DateRangeExportTaskParameter) (*http.Request, error)

CreateCrashesTaskPreparer prepares the CreateCrashesTask request.

func (ExportTasksClient) CreateCrashesTaskResponder 

func (client ExportTasksClient) CreateCrashesTaskResponder(resp *http.Response) (result ExportTaskResult, err error)

CreateCrashesTaskResponder handles the response to the CreateCrashesTask request. The method always closes the http.Response Body.

func (ExportTasksClient) CreateCrashesTaskSender 

func (client ExportTasksClient) CreateCrashesTaskSender(req *http.Request) (*http.Response, error)

CreateCrashesTaskSender sends the CreateCrashesTask request. The method will close the http.Response Body if it receives an error.

func (ExportTasksClient) CreateErrorsTask 

func (client ExportTasksClient) CreateErrorsTask(parameters DateRangeExportTaskParameter) (result ExportTaskResult, err error)

CreateErrorsTask creates a task to export errors.

func (ExportTasksClient) CreateErrorsTaskPreparer 

func (client ExportTasksClient) CreateErrorsTaskPreparer(parameters DateRangeExportTaskParameter) (*http.Request, error)

CreateErrorsTaskPreparer prepares the CreateErrorsTask request.

func (ExportTasksClient) CreateErrorsTaskResponder 

func (client ExportTasksClient) CreateErrorsTaskResponder(resp *http.Response) (result ExportTaskResult, err error)

CreateErrorsTaskResponder handles the response to the CreateErrorsTask request. The method always closes the http.Response Body.

func (ExportTasksClient) CreateErrorsTaskSender 

func (client ExportTasksClient) CreateErrorsTaskSender(req *http.Request) (*http.Response, error)

CreateErrorsTaskSender sends the CreateErrorsTask request. The method will close the http.Response Body if it receives an error.

func (ExportTasksClient) CreateEventsTask 

func (client ExportTasksClient) CreateEventsTask(parameters DateRangeExportTaskParameter) (result ExportTaskResult, err error)

CreateEventsTask creates a task to export events.

func (ExportTasksClient) CreateEventsTaskPreparer 

func (client ExportTasksClient) CreateEventsTaskPreparer(parameters DateRangeExportTaskParameter) (*http.Request, error)

CreateEventsTaskPreparer prepares the CreateEventsTask request.

func (ExportTasksClient) CreateEventsTaskResponder 

func (client ExportTasksClient) CreateEventsTaskResponder(resp *http.Response) (result ExportTaskResult, err error)

CreateEventsTaskResponder handles the response to the CreateEventsTask request. The method always closes the http.Response Body.

func (ExportTasksClient) CreateEventsTaskSender 

func (client ExportTasksClient) CreateEventsTaskSender(req *http.Request) (*http.Response, error)

CreateEventsTaskSender sends the CreateEventsTask request. The method will close the http.Response Body if it receives an error.

func (ExportTasksClient) CreateFeedbackTaskByCampaign 

func (client ExportTasksClient) CreateFeedbackTaskByCampaign(parameters FeedbackByCampaignParameter) (result ExportTaskResult, err error)

CreateFeedbackTaskByCampaign creates a task to export push campaign data for a set of campaigns.

func (ExportTasksClient) CreateFeedbackTaskByCampaignPreparer 

func (client ExportTasksClient) CreateFeedbackTaskByCampaignPreparer(parameters FeedbackByCampaignParameter) (*http.Request, error)

CreateFeedbackTaskByCampaignPreparer prepares the CreateFeedbackTaskByCampaign request.

func (ExportTasksClient) CreateFeedbackTaskByCampaignResponder 

func (client ExportTasksClient) CreateFeedbackTaskByCampaignResponder(resp *http.Response) (result ExportTaskResult, err error)

CreateFeedbackTaskByCampaignResponder handles the response to the CreateFeedbackTaskByCampaign request. The method always closes the http.Response Body.

func (ExportTasksClient) CreateFeedbackTaskByCampaignSender 

func (client ExportTasksClient) CreateFeedbackTaskByCampaignSender(req *http.Request) (*http.Response, error)

CreateFeedbackTaskByCampaignSender sends the CreateFeedbackTaskByCampaign request. The method will close the http.Response Body if it receives an error.

func (ExportTasksClient) CreateFeedbackTaskByDateRange 

func (client ExportTasksClient) CreateFeedbackTaskByDateRange(parameters FeedbackByDateRangeParameter) (result ExportTaskResult, err error)

CreateFeedbackTaskByDateRange creates a task to export push campaign data for a date range.

func (ExportTasksClient) CreateFeedbackTaskByDateRangePreparer 

func (client ExportTasksClient) CreateFeedbackTaskByDateRangePreparer(parameters FeedbackByDateRangeParameter) (*http.Request, error)

CreateFeedbackTaskByDateRangePreparer prepares the CreateFeedbackTaskByDateRange request.

func (ExportTasksClient) CreateFeedbackTaskByDateRangeResponder 

func (client ExportTasksClient) CreateFeedbackTaskByDateRangeResponder(resp *http.Response) (result ExportTaskResult, err error)

CreateFeedbackTaskByDateRangeResponder handles the response to the CreateFeedbackTaskByDateRange request. The method always closes the http.Response Body.

func (ExportTasksClient) CreateFeedbackTaskByDateRangeSender 

func (client ExportTasksClient) CreateFeedbackTaskByDateRangeSender(req *http.Request) (*http.Response, error)

CreateFeedbackTaskByDateRangeSender sends the CreateFeedbackTaskByDateRange request. The method will close the http.Response Body if it receives an error.

func (ExportTasksClient) CreateJobsTask 

func (client ExportTasksClient) CreateJobsTask(parameters DateRangeExportTaskParameter) (result ExportTaskResult, err error)

CreateJobsTask creates a task to export jobs.

func (ExportTasksClient) CreateJobsTaskPreparer 

func (client ExportTasksClient) CreateJobsTaskPreparer(parameters DateRangeExportTaskParameter) (*http.Request, error)

CreateJobsTaskPreparer prepares the CreateJobsTask request.

func (ExportTasksClient) CreateJobsTaskResponder 

func (client ExportTasksClient) CreateJobsTaskResponder(resp *http.Response) (result ExportTaskResult, err error)

CreateJobsTaskResponder handles the response to the CreateJobsTask request. The method always closes the http.Response Body.

func (ExportTasksClient) CreateJobsTaskSender 

func (client ExportTasksClient) CreateJobsTaskSender(req *http.Request) (*http.Response, error)

CreateJobsTaskSender sends the CreateJobsTask request. The method will close the http.Response Body if it receives an error.

func (ExportTasksClient) CreateSessionsTask 

func (client ExportTasksClient) CreateSessionsTask(parameters DateRangeExportTaskParameter) (result ExportTaskResult, err error)

CreateSessionsTask creates a task to export sessions.

func (ExportTasksClient) CreateSessionsTaskPreparer 

func (client ExportTasksClient) CreateSessionsTaskPreparer(parameters DateRangeExportTaskParameter) (*http.Request, error)

CreateSessionsTaskPreparer prepares the CreateSessionsTask request.

func (ExportTasksClient) CreateSessionsTaskResponder 

func (client ExportTasksClient) CreateSessionsTaskResponder(resp *http.Response) (result ExportTaskResult, err error)

CreateSessionsTaskResponder handles the response to the CreateSessionsTask request. The method always closes the http.Response Body.

func (ExportTasksClient) CreateSessionsTaskSender 

func (client ExportTasksClient) CreateSessionsTaskSender(req *http.Request) (*http.Response, error)

CreateSessionsTaskSender sends the CreateSessionsTask request. The method will close the http.Response Body if it receives an error.

func (ExportTasksClient) CreateTagsTask 

func (client ExportTasksClient) CreateTagsTask(parameters ExportTaskParameter) (result ExportTaskResult, err error)

CreateTagsTask creates a task to export tags.

func (ExportTasksClient) CreateTagsTaskPreparer 

func (client ExportTasksClient) CreateTagsTaskPreparer(parameters ExportTaskParameter) (*http.Request, error)

CreateTagsTaskPreparer prepares the CreateTagsTask request.

func (ExportTasksClient) CreateTagsTaskResponder 

func (client ExportTasksClient) CreateTagsTaskResponder(resp *http.Response) (result ExportTaskResult, err error)

CreateTagsTaskResponder handles the response to the CreateTagsTask request. The method always closes the http.Response Body.

func (ExportTasksClient) CreateTagsTaskSender 

func (client ExportTasksClient) CreateTagsTaskSender(req *http.Request) (*http.Response, error)

CreateTagsTaskSender sends the CreateTagsTask request. The method will close the http.Response Body if it receives an error.

func (ExportTasksClient) CreateTokensTask 

func (client ExportTasksClient) CreateTokensTask(parameters ExportTaskParameter) (result ExportTaskResult, err error)

CreateTokensTask creates a task to export tags.

func (ExportTasksClient) CreateTokensTaskPreparer 

func (client ExportTasksClient) CreateTokensTaskPreparer(parameters ExportTaskParameter) (*http.Request, error)

CreateTokensTaskPreparer prepares the CreateTokensTask request.

func (ExportTasksClient) CreateTokensTaskResponder 

func (client ExportTasksClient) CreateTokensTaskResponder(resp *http.Response) (result ExportTaskResult, err error)

CreateTokensTaskResponder handles the response to the CreateTokensTask request. The method always closes the http.Response Body.

func (ExportTasksClient) CreateTokensTaskSender 

func (client ExportTasksClient) CreateTokensTaskSender(req *http.Request) (*http.Response, error)

CreateTokensTaskSender sends the CreateTokensTask request. The method will close the http.Response Body if it receives an error.

func (ExportTasksClient) Get 

func (client ExportTasksClient) Get(id string) (result ExportTaskResult, err error)

Get retrieves information about a previously created export task.

id is export task identifier.

func (ExportTasksClient) GetPreparer 

func (client ExportTasksClient) GetPreparer(id string) (*http.Request, error)

GetPreparer prepares the Get request.

func (ExportTasksClient) GetResponder 

func (client ExportTasksClient) GetResponder(resp *http.Response) (result ExportTaskResult, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (ExportTasksClient) GetSender 

func (client ExportTasksClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (ExportTasksClient) List 

func (client ExportTasksClient) List(skip *int32, top *int32, orderby string) (result ExportTaskListResult, err error)

List get the list of export tasks.

skip is control paging of export tasks, start results at the given offset, defaults to 0 (1st page of data). top is control paging of export tasks, number of export tasks to return with each call. By default, it returns all export tasks with a default paging of 20. The response contains a `nextLink` property describing the path to get the next page if there are more results. The maximum paging limit for $top is 40. orderby is sort results by an expression which looks like `$orderby=taskId asc` (default when not specified). The syntax is orderby={property} {direction} or just orderby={property}. Properties that can be specified for sorting: taskId, errorDetails, dateCreated, taskStatus, and dateCreated. The available directions are asc (for ascending order) and desc (for descending order). When not specified the asc direction is used. Only one orderby property can be specified.

func (ExportTasksClient) ListNextResults 

func (client ExportTasksClient) ListNextResults(lastResults ExportTaskListResult) (result ExportTaskListResult, err error)

ListNextResults retrieves the next set of results, if any.

func (ExportTasksClient) ListPreparer 

func (client ExportTasksClient) ListPreparer(skip *int32, top *int32, orderby string) (*http.Request, error)

ListPreparer prepares the List request.

func (ExportTasksClient) ListResponder 

func (client ExportTasksClient) ListResponder(resp *http.Response) (result ExportTaskListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (ExportTasksClient) ListSender 

func (client ExportTasksClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type ExportType 

type ExportType string

ExportType enumerates the values for export type. 

const (
	// ExportTypeActivity specifies the export type activity state for export
	// type.
	ExportTypeActivity ExportType = "Activity"
	// ExportTypeCrash specifies the export type crash state for export type.
	ExportTypeCrash ExportType = "Crash"
	// ExportTypeError specifies the export type error state for export type.
	ExportTypeError ExportType = "Error"
	// ExportTypeEvent specifies the export type event state for export type.
	ExportTypeEvent ExportType = "Event"
	// ExportTypeJob specifies the export type job state for export type.
	ExportTypeJob ExportType = "Job"
	// ExportTypePush specifies the export type push state for export type.
	ExportTypePush ExportType = "Push"
	// ExportTypeSession specifies the export type session state for export
	// type.
	ExportTypeSession ExportType = "Session"
	// ExportTypeTag specifies the export type tag state for export type.
	ExportTypeTag ExportType = "Tag"
	// ExportTypeToken specifies the export type token state for export type.
	ExportTypeToken ExportType = "Token"
)

type FeedbackByCampaignParameter 

type FeedbackByCampaignParameter struct {
	ContainerURL *string      `json:"containerUrl,omitempty"`
	Description  *string      `json:"description,omitempty"`
	CampaignType CampaignType `json:"campaignType,omitempty"`
	CampaignIds  *[]int32     `json:"campaignIds,omitempty"`
	ExportFormat ExportFormat `json:"exportFormat,omitempty"`
}

FeedbackByCampaignParameter is

type FeedbackByDateRangeParameter 

type FeedbackByDateRangeParameter struct {
	ContainerURL        *string      `json:"containerUrl,omitempty"`
	Description         *string      `json:"description,omitempty"`
	CampaignType        CampaignType `json:"campaignType,omitempty"`
	CampaignWindowStart *date.Time   `json:"campaignWindowStart,omitempty"`
	CampaignWindowEnd   *date.Time   `json:"campaignWindowEnd,omitempty"`
	ExportFormat        ExportFormat `json:"exportFormat,omitempty"`
}

FeedbackByDateRangeParameter is

type Filter 

type Filter struct {
}

Filter is

type FirmwareVersionCriterion 

type FirmwareVersionCriterion struct {
	Name *string `json:"name,omitempty"`
}

FirmwareVersionCriterion is used to target devices based on their firmware version.

type GeoFencingCriterion 

type GeoFencingCriterion struct {
	Lat        *float64 `json:"lat,omitempty"`
	Lon        *float64 `json:"lon,omitempty"`
	Radius     *int32   `json:"radius,omitempty"`
	Expiration *int32   `json:"expiration,omitempty"`
}

GeoFencingCriterion is used to target devices based on a specific region. A center point (defined by a latitude and longitude) and a radius form the boundary for the region. This criterion will be met when the user crosses the boundaries of the region.

type ImportTask 

type ImportTask struct {
	StorageURL *string `json:"storageUrl,omitempty"`
}

ImportTask is

type ImportTaskListResult 

type ImportTaskListResult struct {
	autorest.Response `json:"-"`
	Value             *[]ImportTaskResult `json:"value,omitempty"`
	NextLink          *string             `json:"nextLink,omitempty"`
}

ImportTaskListResult is gets a paged list of import tasks.

func (ImportTaskListResult) ImportTaskListResultPreparer 

func (client ImportTaskListResult) ImportTaskListResultPreparer() (*http.Request, error)

ImportTaskListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type ImportTaskResult 

type ImportTaskResult struct {
	autorest.Response `json:"-"`
	StorageURL        *string    `json:"storageUrl,omitempty"`
	ID                *string    `json:"id,omitempty"`
	State             JobStates  `json:"state,omitempty"`
	DateCreated       *date.Time `json:"dateCreated,omitempty"`
	DateCompleted     *date.Time `json:"dateCompleted,omitempty"`
	ErrorDetails      *string    `json:"errorDetails,omitempty"`
}

ImportTaskResult is

type ImportTasksClient 

type ImportTasksClient struct {
	ManagementClient
}

ImportTasksClient is the microsoft Azure Mobile Engagement REST APIs.

func NewImportTasksClient 

func NewImportTasksClient(subscriptionID string, resourceGroupName string, appCollection string, appName string) ImportTasksClient

NewImportTasksClient creates an instance of the ImportTasksClient client.

func NewImportTasksClientWithBaseURI 

func NewImportTasksClientWithBaseURI(baseURI string, subscriptionID string, resourceGroupName string, appCollection string, appName string) ImportTasksClient

NewImportTasksClientWithBaseURI creates an instance of the ImportTasksClient client.

func (ImportTasksClient) Create 

func (client ImportTasksClient) Create(parameters ImportTask) (result ImportTaskResult, err error)

Create creates a job to import the specified data to a storageUrl.

func (ImportTasksClient) CreatePreparer 

func (client ImportTasksClient) CreatePreparer(parameters ImportTask) (*http.Request, error)

CreatePreparer prepares the Create request.

func (ImportTasksClient) CreateResponder 

func (client ImportTasksClient) CreateResponder(resp *http.Response) (result ImportTaskResult, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (ImportTasksClient) CreateSender 

func (client ImportTasksClient) CreateSender(req *http.Request) (*http.Response, error)

CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.

func (ImportTasksClient) Get 

func (client ImportTasksClient) Get(id string) (result ImportTaskResult, err error)

Get the Get import job operation retrieves information about a previously created import job.

id is import job identifier.

func (ImportTasksClient) GetPreparer 

func (client ImportTasksClient) GetPreparer(id string) (*http.Request, error)

GetPreparer prepares the Get request.

func (ImportTasksClient) GetResponder 

func (client ImportTasksClient) GetResponder(resp *http.Response) (result ImportTaskResult, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (ImportTasksClient) GetSender 

func (client ImportTasksClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (ImportTasksClient) List 

func (client ImportTasksClient) List(skip *int32, top *int32, orderby string) (result ImportTaskListResult, err error)

List get the list of import jobs.

skip is control paging of import jobs, start results at the given offset, defaults to 0 (1st page of data). top is control paging of import jobs, number of import jobs to return with each call. By default, it returns all import jobs with a default paging of 20. The response contains a `nextLink` property describing the path to get the next page if there are more results. The maximum paging limit for $top is 40. orderby is sort results by an expression which looks like `$orderby=jobId asc` (default when not specified). The syntax is orderby={property} {direction} or just orderby={property}. Properties that can be specified for sorting: jobId, errorDetails, dateCreated, jobStatus, and dateCreated. The available directions are asc (for ascending order) and desc (for descending order). When not specified the asc direction is used. Only one orderby property can be specified.

func (ImportTasksClient) ListNextResults 

func (client ImportTasksClient) ListNextResults(lastResults ImportTaskListResult) (result ImportTaskListResult, err error)

ListNextResults retrieves the next set of results, if any.

func (ImportTasksClient) ListPreparer 

func (client ImportTasksClient) ListPreparer(skip *int32, top *int32, orderby string) (*http.Request, error)

ListPreparer prepares the List request.

func (ImportTasksClient) ListResponder 

func (client ImportTasksClient) ListResponder(resp *http.Response) (result ImportTaskListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (ImportTasksClient) ListSender 

func (client ImportTasksClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type IntegerTagCriterion 

type IntegerTagCriterion struct {
	Name  *string           `json:"name,omitempty"`
	Value *int32            `json:"value,omitempty"`
	Op    AudienceOperators `json:"op,omitempty"`
}

IntegerTagCriterion is target devices based on an integer tag value.

type JobStates 

type JobStates string

JobStates enumerates the values for job states. 

const (
	// JobStatesFailed specifies the job states failed state for job states.
	JobStatesFailed JobStates = "Failed"
	// JobStatesQueued specifies the job states queued state for job states.
	JobStatesQueued JobStates = "Queued"
	// JobStatesStarted specifies the job states started state for job states.
	JobStatesStarted JobStates = "Started"
	// JobStatesSucceeded specifies the job states succeeded state for job
	// states.
	JobStatesSucceeded JobStates = "Succeeded"
)

type LanguageCriterion 

type LanguageCriterion struct {
	Name *string `json:"name,omitempty"`
}

LanguageCriterion is used to target devices based on the language of their device.

type LocationCriterion 

type LocationCriterion struct {
	Country  *string `json:"country,omitempty"`
	Region   *string `json:"region,omitempty"`
	Locality *string `json:"locality,omitempty"`
}

LocationCriterion is used to target devices based on their last know area.

type ManagementClient 

type ManagementClient struct {
	autorest.Client
	BaseURI           string
	APIVersion        string
	SubscriptionID    string
	ResourceGroupName string
	AppCollection     string
	AppName           string
}

ManagementClient is the base client for Mobileengagement.

func New 

func New(subscriptionID string, resourceGroupName string, appCollection string, appName string) ManagementClient

New creates an instance of the ManagementClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string, subscriptionID string, resourceGroupName string, appCollection string, appName string) ManagementClient

NewWithBaseURI creates an instance of the ManagementClient client.

type NativePushEnabledFilter 

type NativePushEnabledFilter struct {
}

NativePushEnabledFilter is engage only users with native push enabled.

type NetworkTypeCriterion 

type NetworkTypeCriterion struct {
	Name *string `json:"name,omitempty"`
}

NetworkTypeCriterion is used to target devices based their network type.

type NotificationOptions 

type NotificationOptions struct {
	BigText    *string `json:"bigText,omitempty"`
	BigPicture *string `json:"bigPicture,omitempty"`
	Sound      *string `json:"sound,omitempty"`
	ActionText *string `json:"actionText,omitempty"`
}

NotificationOptions is

type NotificationTypes 

type NotificationTypes string

NotificationTypes enumerates the values for notification types. 

const (
	// Popup specifies the popup state for notification types.
	Popup NotificationTypes = "popup"
	// System specifies the system state for notification types.
	System NotificationTypes = "system"
)

type PollAnswerFeedbackCriterion 

type PollAnswerFeedbackCriterion struct {
	ContentID *int32 `json:"content-id,omitempty"`
	ChoiceID  *int32 `json:"choice-id,omitempty"`
}

PollAnswerFeedbackCriterion is used to target devices who answered X to a given question.

type PollFeedbackCriterion 

type PollFeedbackCriterion struct {
	ContentID *int32            `json:"content-id,omitempty"`
	Action    CampaignFeedbacks `json:"action,omitempty"`
}

PollFeedbackCriterion is used to target devices who received a poll.

type PollQuestion 

type PollQuestion struct {
	Title        *string                               `json:"title,omitempty"`
	ID           *int32                                `json:"id,omitempty"`
	Localization *map[string]*PollQuestionLocalization `json:"localization,omitempty"`
	Choices      *[]PollQuestionChoice                 `json:"choices,omitempty"`
}

PollQuestion is

type PollQuestionChoice 

type PollQuestionChoice struct {
	Title        *string                                     `json:"title,omitempty"`
	ID           *int32                                      `json:"id,omitempty"`
	Localization *map[string]*PollQuestionChoiceLocalization `json:"localization,omitempty"`
	IsDefault    *bool                                       `json:"isDefault,omitempty"`
}

PollQuestionChoice is

type PollQuestionChoiceLocalization 

type PollQuestionChoiceLocalization struct {
	Title *string `json:"title,omitempty"`
}

PollQuestionChoiceLocalization is

type PollQuestionLocalization 

type PollQuestionLocalization struct {
	Title *string `json:"title,omitempty"`
}

PollQuestionLocalization is

type ProvisioningStates 

type ProvisioningStates string

ProvisioningStates enumerates the values for provisioning states. 

const (
	// Creating specifies the creating state for provisioning states.
	Creating ProvisioningStates = "Creating"
	// Succeeded specifies the succeeded state for provisioning states.
	Succeeded ProvisioningStates = "Succeeded"
)

type PushModes 

type PushModes string

PushModes enumerates the values for push modes. 

const (
	// Manual specifies the manual state for push modes.
	Manual PushModes = "manual"
	// OneShot specifies the one shot state for push modes.
	OneShot PushModes = "one-shot"
	// RealTime specifies the real time state for push modes.
	RealTime PushModes = "real-time"
)

type PushQuotaFilter 

type PushQuotaFilter struct {
}

PushQuotaFilter is engage only users for whom the push quota is not reached.

type Resource 

type Resource struct {
	ID       *string             `json:"id,omitempty"`
	Name     *string             `json:"name,omitempty"`
	Type     *string             `json:"type,omitempty"`
	Location *string             `json:"location,omitempty"`
	Tags     *map[string]*string `json:"tags,omitempty"`
}

Resource is

type ScreenSizeCriterion 

type ScreenSizeCriterion struct {
	Name *string `json:"name,omitempty"`
}

ScreenSizeCriterion is used to target devices based on the screen resolution of their device.

type SegmentCriterion 

type SegmentCriterion struct {
	ID      *int32 `json:"id,omitempty"`
	Exclude *bool  `json:"exclude,omitempty"`
}

SegmentCriterion is target devices based on an existing segment.

type StringTagCriterion 

type StringTagCriterion struct {
	Name  *string `json:"name,omitempty"`
	Value *string `json:"value,omitempty"`
}

StringTagCriterion is target devices based on a string tag value.

type SupportedPlatformsClient 

type SupportedPlatformsClient struct {
	ManagementClient
}

SupportedPlatformsClient is the microsoft Azure Mobile Engagement REST APIs.

func NewSupportedPlatformsClient 

func NewSupportedPlatformsClient(subscriptionID string, resourceGroupName string, appCollection string, appName string) SupportedPlatformsClient

NewSupportedPlatformsClient creates an instance of the SupportedPlatformsClient client.

func NewSupportedPlatformsClientWithBaseURI 

func NewSupportedPlatformsClientWithBaseURI(baseURI string, subscriptionID string, resourceGroupName string, appCollection string, appName string) SupportedPlatformsClient

NewSupportedPlatformsClientWithBaseURI creates an instance of the SupportedPlatformsClient client.

func (SupportedPlatformsClient) List 

func (client SupportedPlatformsClient) List() (result SupportedPlatformsListResult, err error)

List lists supported platforms for Engagement applications.

func (SupportedPlatformsClient) ListPreparer 

func (client SupportedPlatformsClient) ListPreparer() (*http.Request, error)

ListPreparer prepares the List request.

func (SupportedPlatformsClient) ListResponder 

func (client SupportedPlatformsClient) ListResponder(resp *http.Response) (result SupportedPlatformsListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (SupportedPlatformsClient) ListSender 

func (client SupportedPlatformsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type SupportedPlatformsListResult 

type SupportedPlatformsListResult struct {
	autorest.Response `json:"-"`
	Platforms         *[]string `json:"platforms,omitempty"`
}

SupportedPlatformsListResult is

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.