subscriptions

package
v1.53.0 Latest Latest
Warning

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

 Go to latest Published: Nov 28, 2024 License: MIT Imports: 4 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ItemReauthorizeRequestBuilder added in v0.49.0 

type ItemReauthorizeRequestBuilder struct {
	i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}

ItemReauthorizeRequestBuilder provides operations to call the reauthorize method.

func NewItemReauthorizeRequestBuilder added in v0.49.0 

func NewItemReauthorizeRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ItemReauthorizeRequestBuilder

NewItemReauthorizeRequestBuilder instantiates a new ItemReauthorizeRequestBuilder and sets the default values.

func NewItemReauthorizeRequestBuilderInternal added in v0.49.0 

func NewItemReauthorizeRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ItemReauthorizeRequestBuilder

NewItemReauthorizeRequestBuilderInternal instantiates a new ItemReauthorizeRequestBuilder and sets the default values.

func (*ItemReauthorizeRequestBuilder) Post added in v0.49.0 

func (m *ItemReauthorizeRequestBuilder) Post(ctx context.Context, requestConfiguration *ItemReauthorizeRequestBuilderPostRequestConfiguration) error

Post reauthorize a subscription when you receive a reauthorizationRequired challenge. returns a ODataError error when the service returns a 4XX or 5XX status code Find more info here

func (*ItemReauthorizeRequestBuilder) ToPostRequestInformation added in v0.51.0 

func (m *ItemReauthorizeRequestBuilder) ToPostRequestInformation(ctx context.Context, requestConfiguration *ItemReauthorizeRequestBuilderPostRequestConfiguration) (*i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestInformation, error)

ToPostRequestInformation reauthorize a subscription when you receive a reauthorizationRequired challenge. returns a *RequestInformation when successful

func (*ItemReauthorizeRequestBuilder) WithUrl added in v1.18.0 

func (m *ItemReauthorizeRequestBuilder) WithUrl(rawUrl string) *ItemReauthorizeRequestBuilder

WithUrl returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored. returns a *ItemReauthorizeRequestBuilder when successful

type ItemReauthorizeRequestBuilderPostRequestConfiguration added in v0.49.0 

type ItemReauthorizeRequestBuilderPostRequestConfiguration struct {
	// Request headers
	Headers *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestHeaders
	// Request options
	Options []i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestOption
}

ItemReauthorizeRequestBuilderPostRequestConfiguration configuration for the request such as headers, query parameters, and middleware options.

type SubscriptionItemRequestBuilder added in v0.49.0 

type SubscriptionItemRequestBuilder struct {
	i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}

SubscriptionItemRequestBuilder provides operations to manage the collection of subscription entities.

func NewSubscriptionItemRequestBuilder added in v0.49.0 

func NewSubscriptionItemRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *SubscriptionItemRequestBuilder

NewSubscriptionItemRequestBuilder instantiates a new SubscriptionItemRequestBuilder and sets the default values.

func NewSubscriptionItemRequestBuilderInternal added in v0.49.0 

func NewSubscriptionItemRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *SubscriptionItemRequestBuilder

NewSubscriptionItemRequestBuilderInternal instantiates a new SubscriptionItemRequestBuilder and sets the default values.

func (*SubscriptionItemRequestBuilder) Delete added in v0.49.0 

func (m *SubscriptionItemRequestBuilder) Delete(ctx context.Context, requestConfiguration *SubscriptionItemRequestBuilderDeleteRequestConfiguration) error

Delete delete a subscription. For the list of resources that support subscribing to change notifications, see the table in the Permissions section. returns a ODataError error when the service returns a 4XX or 5XX status code Find more info here

func (*SubscriptionItemRequestBuilder) Get added in v0.49.0 

func (m *SubscriptionItemRequestBuilder) Get(ctx context.Context, requestConfiguration *SubscriptionItemRequestBuilderGetRequestConfiguration) (iadcd81124412c61e647227ecfc4449d8bba17de0380ddda76f641a29edf2b242.Subscriptionable, error)

Get retrieve the properties and relationships of a subscription. See the table in the Permissions section for the list of resources that support subscribing to change notifications. returns a Subscriptionable when successful returns a ODataError error when the service returns a 4XX or 5XX status code Find more info here

func (*SubscriptionItemRequestBuilder) Patch added in v0.49.0 

func (m *SubscriptionItemRequestBuilder) Patch(ctx context.Context, body iadcd81124412c61e647227ecfc4449d8bba17de0380ddda76f641a29edf2b242.Subscriptionable, requestConfiguration *SubscriptionItemRequestBuilderPatchRequestConfiguration) (iadcd81124412c61e647227ecfc4449d8bba17de0380ddda76f641a29edf2b242.Subscriptionable, error)

Patch renew a subscription by extending its expiry time. The table in the Permissions section lists the resources that support subscribing to change notifications. Subscriptions expire after a length of time that varies by resource type. In order to avoid missing change notifications, an app should renew its subscriptions well in advance of their expiry date. See subscription for maximum length of a subscription for each resource type. returns a Subscriptionable when successful returns a ODataError error when the service returns a 4XX or 5XX status code Find more info here

func (*SubscriptionItemRequestBuilder) Reauthorize added in v0.49.0 

func (m *SubscriptionItemRequestBuilder) Reauthorize() *ItemReauthorizeRequestBuilder

Reauthorize provides operations to call the reauthorize method. returns a *ItemReauthorizeRequestBuilder when successful

func (*SubscriptionItemRequestBuilder) ToDeleteRequestInformation added in v0.51.0 

func (m *SubscriptionItemRequestBuilder) ToDeleteRequestInformation(ctx context.Context, requestConfiguration *SubscriptionItemRequestBuilderDeleteRequestConfiguration) (*i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestInformation, error)

ToDeleteRequestInformation delete a subscription. For the list of resources that support subscribing to change notifications, see the table in the Permissions section. returns a *RequestInformation when successful

func (*SubscriptionItemRequestBuilder) ToGetRequestInformation added in v0.51.0 

func (m *SubscriptionItemRequestBuilder) ToGetRequestInformation(ctx context.Context, requestConfiguration *SubscriptionItemRequestBuilderGetRequestConfiguration) (*i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestInformation, error)

ToGetRequestInformation retrieve the properties and relationships of a subscription. See the table in the Permissions section for the list of resources that support subscribing to change notifications. returns a *RequestInformation when successful

func (*SubscriptionItemRequestBuilder) ToPatchRequestInformation added in v0.51.0 

func (m *SubscriptionItemRequestBuilder) ToPatchRequestInformation(ctx context.Context, body iadcd81124412c61e647227ecfc4449d8bba17de0380ddda76f641a29edf2b242.Subscriptionable, requestConfiguration *SubscriptionItemRequestBuilderPatchRequestConfiguration) (*i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestInformation, error)

ToPatchRequestInformation renew a subscription by extending its expiry time. The table in the Permissions section lists the resources that support subscribing to change notifications. Subscriptions expire after a length of time that varies by resource type. In order to avoid missing change notifications, an app should renew its subscriptions well in advance of their expiry date. See subscription for maximum length of a subscription for each resource type. returns a *RequestInformation when successful

func (*SubscriptionItemRequestBuilder) WithUrl added in v1.18.0 

func (m *SubscriptionItemRequestBuilder) WithUrl(rawUrl string) *SubscriptionItemRequestBuilder

WithUrl returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored. returns a *SubscriptionItemRequestBuilder when successful

type SubscriptionItemRequestBuilderDeleteRequestConfiguration added in v0.49.0 

type SubscriptionItemRequestBuilderDeleteRequestConfiguration struct {
	// Request headers
	Headers *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestHeaders
	// Request options
	Options []i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestOption
}

SubscriptionItemRequestBuilderDeleteRequestConfiguration configuration for the request such as headers, query parameters, and middleware options.

type SubscriptionItemRequestBuilderGetQueryParameters added in v0.49.0 

type SubscriptionItemRequestBuilderGetQueryParameters struct {
	// Select properties to be returned
	Select []string `uriparametername:"%24select"`
}

SubscriptionItemRequestBuilderGetQueryParameters retrieve the properties and relationships of a subscription. See the table in the Permissions section for the list of resources that support subscribing to change notifications.

type SubscriptionItemRequestBuilderGetRequestConfiguration added in v0.49.0 

type SubscriptionItemRequestBuilderGetRequestConfiguration struct {
	// Request headers
	Headers *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestHeaders
	// Request options
	Options []i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestOption
	// Request query parameters
	QueryParameters *SubscriptionItemRequestBuilderGetQueryParameters
}

SubscriptionItemRequestBuilderGetRequestConfiguration configuration for the request such as headers, query parameters, and middleware options.

type SubscriptionItemRequestBuilderPatchRequestConfiguration added in v0.49.0 

type SubscriptionItemRequestBuilderPatchRequestConfiguration struct {
	// Request headers
	Headers *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestHeaders
	// Request options
	Options []i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestOption
}

SubscriptionItemRequestBuilderPatchRequestConfiguration configuration for the request such as headers, query parameters, and middleware options.

type SubscriptionsRequestBuilder 

type SubscriptionsRequestBuilder struct {
	i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}

SubscriptionsRequestBuilder provides operations to manage the collection of subscription entities.

func NewSubscriptionsRequestBuilder 

func NewSubscriptionsRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *SubscriptionsRequestBuilder

NewSubscriptionsRequestBuilder instantiates a new SubscriptionsRequestBuilder and sets the default values.

func NewSubscriptionsRequestBuilderInternal 

func NewSubscriptionsRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *SubscriptionsRequestBuilder

NewSubscriptionsRequestBuilderInternal instantiates a new SubscriptionsRequestBuilder and sets the default values.

func (*SubscriptionsRequestBuilder) BySubscriptionId added in v0.63.0 

func (m *SubscriptionsRequestBuilder) BySubscriptionId(subscriptionId string) *SubscriptionItemRequestBuilder

BySubscriptionId provides operations to manage the collection of subscription entities. returns a *SubscriptionItemRequestBuilder when successful

func (*SubscriptionsRequestBuilder) Get 

func (m *SubscriptionsRequestBuilder) Get(ctx context.Context, requestConfiguration *SubscriptionsRequestBuilderGetRequestConfiguration) (iadcd81124412c61e647227ecfc4449d8bba17de0380ddda76f641a29edf2b242.SubscriptionCollectionResponseable, error)

Get retrieve the properties and relationships of webhook subscriptions, based on the app ID, the user, and the user's role with a tenant. The content of the response depends on the context in which the app is calling; for details, see the scenarios in the Permissions section. returns a SubscriptionCollectionResponseable when successful returns a ODataError error when the service returns a 4XX or 5XX status code Find more info here

func (*SubscriptionsRequestBuilder) Post 

func (m *SubscriptionsRequestBuilder) Post(ctx context.Context, body iadcd81124412c61e647227ecfc4449d8bba17de0380ddda76f641a29edf2b242.Subscriptionable, requestConfiguration *SubscriptionsRequestBuilderPostRequestConfiguration) (iadcd81124412c61e647227ecfc4449d8bba17de0380ddda76f641a29edf2b242.Subscriptionable, error)

Post subscribes a listener application to receive change notifications when the requested type of changes occur to the specified resource in Microsoft Graph. To identify the resources for which you can create subscriptions and the limitations on subscriptions, see Set up notifications for changes in resource data: Supported resources. Some resources support rich notifications, that is, notifications that include resource data. For more information about these resources, see Set up change notifications that include resource data: Supported resources. returns a Subscriptionable when successful returns a ODataError error when the service returns a 4XX or 5XX status code Find more info here

func (*SubscriptionsRequestBuilder) ToGetRequestInformation added in v0.51.0 

func (m *SubscriptionsRequestBuilder) ToGetRequestInformation(ctx context.Context, requestConfiguration *SubscriptionsRequestBuilderGetRequestConfiguration) (*i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestInformation, error)

ToGetRequestInformation retrieve the properties and relationships of webhook subscriptions, based on the app ID, the user, and the user's role with a tenant. The content of the response depends on the context in which the app is calling; for details, see the scenarios in the Permissions section. returns a *RequestInformation when successful

func (*SubscriptionsRequestBuilder) ToPostRequestInformation added in v0.51.0 

func (m *SubscriptionsRequestBuilder) ToPostRequestInformation(ctx context.Context, body iadcd81124412c61e647227ecfc4449d8bba17de0380ddda76f641a29edf2b242.Subscriptionable, requestConfiguration *SubscriptionsRequestBuilderPostRequestConfiguration) (*i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestInformation, error)

ToPostRequestInformation subscribes a listener application to receive change notifications when the requested type of changes occur to the specified resource in Microsoft Graph. To identify the resources for which you can create subscriptions and the limitations on subscriptions, see Set up notifications for changes in resource data: Supported resources. Some resources support rich notifications, that is, notifications that include resource data. For more information about these resources, see Set up change notifications that include resource data: Supported resources. returns a *RequestInformation when successful

func (*SubscriptionsRequestBuilder) WithUrl added in v1.18.0 

func (m *SubscriptionsRequestBuilder) WithUrl(rawUrl string) *SubscriptionsRequestBuilder

WithUrl returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored. returns a *SubscriptionsRequestBuilder when successful

type SubscriptionsRequestBuilderGetQueryParameters 

type SubscriptionsRequestBuilderGetQueryParameters struct {
	// Include count of items
	Count *bool `uriparametername:"%24count"`
	// Expand related entities
	Expand []string `uriparametername:"%24expand"`
	// Filter items by property values
	Filter *string `uriparametername:"%24filter"`
	// Order items by property values
	Orderby []string `uriparametername:"%24orderby"`
	// Search items by search phrases
	Search *string `uriparametername:"%24search"`
	// Select properties to be returned
	Select []string `uriparametername:"%24select"`
	// Skip the first n items
	Skip *int32 `uriparametername:"%24skip"`
	// Show only the first n items
	Top *int32 `uriparametername:"%24top"`
}

SubscriptionsRequestBuilderGetQueryParameters retrieve the properties and relationships of webhook subscriptions, based on the app ID, the user, and the user's role with a tenant. The content of the response depends on the context in which the app is calling; for details, see the scenarios in the Permissions section.

type SubscriptionsRequestBuilderGetRequestConfiguration added in v0.22.0 

type SubscriptionsRequestBuilderGetRequestConfiguration struct {
	// Request headers
	Headers *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestHeaders
	// Request options
	Options []i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestOption
	// Request query parameters
	QueryParameters *SubscriptionsRequestBuilderGetQueryParameters
}

SubscriptionsRequestBuilderGetRequestConfiguration configuration for the request such as headers, query parameters, and middleware options.

type SubscriptionsRequestBuilderPostRequestConfiguration added in v0.22.0 

type SubscriptionsRequestBuilderPostRequestConfiguration struct {
	// Request headers
	Headers *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestHeaders
	// Request options
	Options []i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestOption
}

SubscriptionsRequestBuilderPostRequestConfiguration configuration for the request such as headers, query parameters, and middleware options.

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.