eventinstance

package
v0.20240927.1005214 Latest Latest
Warning

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

Go to latest
Published: Sep 27, 2024 License: MPL-2.0 Imports: 9 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/microsoft-graph/users/stable/eventinstance Documentation

The eventinstance SDK allows for interaction with Microsoft Graph users (API Version stable).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-sdk/microsoft-graph/users/stable/eventinstance"

Client Initialization

client := eventinstance.NewEventInstanceClientWithBaseURI("https://graph.microsoft.com")
client.Client.Authorizer = authorizer

Example Usage: EventInstanceClient.AcceptEventInstance

ctx := context.TODO()
id := eventinstance.NewUserIdEventIdInstanceID("userId", "eventId", "eventId1")

payload := eventinstance.AcceptEventInstanceRequest{
	// ...
}


read, err := client.AcceptEventInstance(ctx, id, payload, eventinstance.DefaultAcceptEventInstanceOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: EventInstanceClient.CancelEventInstance

ctx := context.TODO()
id := eventinstance.NewUserIdEventIdInstanceID("userId", "eventId", "eventId1")

payload := eventinstance.CancelEventInstanceRequest{
	// ...
}


read, err := client.CancelEventInstance(ctx, id, payload, eventinstance.DefaultCancelEventInstanceOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: EventInstanceClient.DeclineEventInstance

ctx := context.TODO()
id := eventinstance.NewUserIdEventIdInstanceID("userId", "eventId", "eventId1")

payload := eventinstance.DeclineEventInstanceRequest{
	// ...
}


read, err := client.DeclineEventInstance(ctx, id, payload, eventinstance.DefaultDeclineEventInstanceOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: EventInstanceClient.DismissEventInstanceReminder

ctx := context.TODO()
id := eventinstance.NewUserIdEventIdInstanceID("userId", "eventId", "eventId1")

read, err := client.DismissEventInstanceReminder(ctx, id, eventinstance.DefaultDismissEventInstanceReminderOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: EventInstanceClient.ForwardEventInstance

ctx := context.TODO()
id := eventinstance.NewUserIdEventIdInstanceID("userId", "eventId", "eventId1")

payload := eventinstance.ForwardEventInstanceRequest{
	// ...
}


read, err := client.ForwardEventInstance(ctx, id, payload, eventinstance.DefaultForwardEventInstanceOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: EventInstanceClient.GetEventInstance

ctx := context.TODO()
id := eventinstance.NewUserIdEventIdInstanceID("userId", "eventId", "eventId1")

read, err := client.GetEventInstance(ctx, id, eventinstance.DefaultGetEventInstanceOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: EventInstanceClient.GetEventInstancesCount

ctx := context.TODO()
id := eventinstance.NewUserIdEventID("userId", "eventId")

read, err := client.GetEventInstancesCount(ctx, id, eventinstance.DefaultGetEventInstancesCountOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: EventInstanceClient.ListEventInstances

ctx := context.TODO()
id := eventinstance.NewUserIdEventID("userId", "eventId")

// alternatively `client.ListEventInstances(ctx, id, eventinstance.DefaultListEventInstancesOperationOptions())` can be used to do batched pagination
items, err := client.ListEventInstancesComplete(ctx, id, eventinstance.DefaultListEventInstancesOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: EventInstanceClient.SnoozeEventInstanceReminder

ctx := context.TODO()
id := eventinstance.NewUserIdEventIdInstanceID("userId", "eventId", "eventId1")

payload := eventinstance.SnoozeEventInstanceReminderRequest{
	// ...
}


read, err := client.SnoozeEventInstanceReminder(ctx, id, payload, eventinstance.DefaultSnoozeEventInstanceReminderOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: EventInstanceClient.TentativelyAcceptEventInstance

ctx := context.TODO()
id := eventinstance.NewUserIdEventIdInstanceID("userId", "eventId", "eventId1")

payload := eventinstance.TentativelyAcceptEventInstanceRequest{
	// ...
}


read, err := client.TentativelyAcceptEventInstance(ctx, id, payload, eventinstance.DefaultTentativelyAcceptEventInstanceOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AcceptEventInstanceOperationOptions

type AcceptEventInstanceOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
}

func DefaultAcceptEventInstanceOperationOptions

func DefaultAcceptEventInstanceOperationOptions() AcceptEventInstanceOperationOptions

func (AcceptEventInstanceOperationOptions) ToHeaders

func (AcceptEventInstanceOperationOptions) ToOData

func (AcceptEventInstanceOperationOptions) ToQuery

type AcceptEventInstanceOperationResponse

type AcceptEventInstanceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type AcceptEventInstanceRequest

type AcceptEventInstanceRequest struct {
	Comment      nullable.Type[string] `json:"Comment,omitempty"`
	SendResponse nullable.Type[bool]   `json:"SendResponse,omitempty"`
}

type CancelEventInstanceOperationOptions

type CancelEventInstanceOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
}

func DefaultCancelEventInstanceOperationOptions

func DefaultCancelEventInstanceOperationOptions() CancelEventInstanceOperationOptions

func (CancelEventInstanceOperationOptions) ToHeaders

func (CancelEventInstanceOperationOptions) ToOData

func (CancelEventInstanceOperationOptions) ToQuery

type CancelEventInstanceOperationResponse

type CancelEventInstanceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type CancelEventInstanceRequest

type CancelEventInstanceRequest struct {
	Comment nullable.Type[string] `json:"Comment,omitempty"`
}

type DeclineEventInstanceOperationOptions

type DeclineEventInstanceOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
}

func DefaultDeclineEventInstanceOperationOptions

func DefaultDeclineEventInstanceOperationOptions() DeclineEventInstanceOperationOptions

func (DeclineEventInstanceOperationOptions) ToHeaders

func (DeclineEventInstanceOperationOptions) ToOData

func (DeclineEventInstanceOperationOptions) ToQuery

type DeclineEventInstanceOperationResponse

type DeclineEventInstanceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type DeclineEventInstanceRequest

type DeclineEventInstanceRequest struct {
	Comment         nullable.Type[string] `json:"Comment,omitempty"`
	ProposedNewTime *stable.TimeSlot      `json:"ProposedNewTime,omitempty"`
	SendResponse    nullable.Type[bool]   `json:"SendResponse,omitempty"`
}

type DismissEventInstanceReminderOperationOptions

type DismissEventInstanceReminderOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
}

func DefaultDismissEventInstanceReminderOperationOptions

func DefaultDismissEventInstanceReminderOperationOptions() DismissEventInstanceReminderOperationOptions

func (DismissEventInstanceReminderOperationOptions) ToHeaders

func (DismissEventInstanceReminderOperationOptions) ToOData

func (DismissEventInstanceReminderOperationOptions) ToQuery

type DismissEventInstanceReminderOperationResponse

type DismissEventInstanceReminderOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type EventInstanceClient

type EventInstanceClient struct {
	Client *msgraph.Client
}

func NewEventInstanceClientWithBaseURI

func NewEventInstanceClientWithBaseURI(sdkApi sdkEnv.Api) (*EventInstanceClient, error)

func (EventInstanceClient) AcceptEventInstance

AcceptEventInstance - Invoke action accept. Accept the specified event in a user calendar.

func (EventInstanceClient) CancelEventInstance

CancelEventInstance - Invoke action cancel. This action allows the organizer of a meeting to send a cancellation message and cancel the event. The action moves the event to the Deleted Items folder. The organizer can also cancel an occurrence of a recurring meeting by providing the occurrence event ID. An attendee calling this action gets an error (HTTP 400 Bad Request), with the following error message: 'Your request can't be completed. You need to be an organizer to cancel a meeting.' This action differs from Delete in that Cancel is available to only the organizer, and lets the organizer send a custom message to the attendees about the cancellation.

func (EventInstanceClient) DeclineEventInstance

DeclineEventInstance - Invoke action decline. Decline invitation to the specified event in a user calendar. If the event allows proposals for new times, on declining the event, an invitee can choose to suggest an alternative time by including the proposedNewTime parameter. For more information on how to propose a time, and how to receive and accept a new time proposal, see Propose new meeting times.

func (EventInstanceClient) DismissEventInstanceReminder

DismissEventInstanceReminder - Invoke action dismissReminder. Dismiss a reminder that has been triggered for an event in a user calendar.

func (EventInstanceClient) ForwardEventInstance

ForwardEventInstance - Invoke action forward. This action allows the organizer or attendee of a meeting event to forward the meeting request to a new recipient. If the meeting event is forwarded from an attendee's Microsoft 365 mailbox to another recipient, this action also sends a message to notify the organizer of the forwarding, and adds the recipient to the organizer's copy of the meeting event. This convenience is not available when forwarding from an Outlook.com account.

func (EventInstanceClient) GetEventInstance

GetEventInstance - Get instances from users. The occurrences of a recurring series, if the event is a series master. This property includes occurrences that are part of the recurrence pattern, and exceptions that have been modified, but does not include occurrences that have been cancelled from the series. Navigation property. Read-only. Nullable.

func (EventInstanceClient) GetEventInstancesCount

GetEventInstancesCount - Get the number of the resource

func (EventInstanceClient) ListEventInstances

ListEventInstances - Get instances from users. The occurrences of a recurring series, if the event is a series master. This property includes occurrences that are part of the recurrence pattern, and exceptions that have been modified, but does not include occurrences that have been cancelled from the series. Navigation property. Read-only. Nullable.

func (EventInstanceClient) ListEventInstancesComplete

ListEventInstancesComplete retrieves all the results into a single object

func (EventInstanceClient) ListEventInstancesCompleteMatchingPredicate

func (c EventInstanceClient) ListEventInstancesCompleteMatchingPredicate(ctx context.Context, id stable.UserIdEventId, options ListEventInstancesOperationOptions, predicate EventOperationPredicate) (result ListEventInstancesCompleteResult, err error)

ListEventInstancesCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (EventInstanceClient) SnoozeEventInstanceReminder

SnoozeEventInstanceReminder - Invoke action snoozeReminder. Postpone a reminder for an event in a user calendar until a new time.

func (EventInstanceClient) TentativelyAcceptEventInstance

TentativelyAcceptEventInstance - Invoke action tentativelyAccept. Tentatively accept the specified event in a user calendar. If the event allows proposals for new times, on responding tentative to the event, an invitee can choose to suggest an alternative time by including the proposedNewTime parameter. For more information on how to propose a time, and how to receive and accept a new time proposal, see Propose new meeting times.

type EventOperationPredicate

type EventOperationPredicate struct {
}

func (EventOperationPredicate) Matches

func (p EventOperationPredicate) Matches(input stable.Event) bool

type ForwardEventInstanceOperationOptions

type ForwardEventInstanceOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
}

func DefaultForwardEventInstanceOperationOptions

func DefaultForwardEventInstanceOperationOptions() ForwardEventInstanceOperationOptions

func (ForwardEventInstanceOperationOptions) ToHeaders

func (ForwardEventInstanceOperationOptions) ToOData

func (ForwardEventInstanceOperationOptions) ToQuery

type ForwardEventInstanceOperationResponse

type ForwardEventInstanceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type ForwardEventInstanceRequest

type ForwardEventInstanceRequest struct {
	Comment      nullable.Type[string] `json:"Comment,omitempty"`
	ToRecipients *[]stable.Recipient   `json:"ToRecipients,omitempty"`
}

type GetEventInstanceOperationOptions

type GetEventInstanceOperationOptions struct {
	EndDateTime   *string
	Expand        *odata.Expand
	Metadata      *odata.Metadata
	RetryFunc     client.RequestRetryFunc
	Select        *[]string
	StartDateTime *string
}

func DefaultGetEventInstanceOperationOptions

func DefaultGetEventInstanceOperationOptions() GetEventInstanceOperationOptions

func (GetEventInstanceOperationOptions) ToHeaders

func (GetEventInstanceOperationOptions) ToOData

func (GetEventInstanceOperationOptions) ToQuery

type GetEventInstanceOperationResponse

type GetEventInstanceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *stable.Event
}

type GetEventInstancesCountOperationOptions

type GetEventInstancesCountOperationOptions struct {
	Filter    *string
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
	Search    *string
}

func DefaultGetEventInstancesCountOperationOptions

func DefaultGetEventInstancesCountOperationOptions() GetEventInstancesCountOperationOptions

func (GetEventInstancesCountOperationOptions) ToHeaders

func (GetEventInstancesCountOperationOptions) ToOData

func (GetEventInstancesCountOperationOptions) ToQuery

type GetEventInstancesCountOperationResponse

type GetEventInstancesCountOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]byte
}

type ListEventInstancesCompleteResult

type ListEventInstancesCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []stable.Event
}

type ListEventInstancesCustomPager

type ListEventInstancesCustomPager struct {
	NextLink *odata.Link `json:"@odata.nextLink"`
}
func (p *ListEventInstancesCustomPager) NextPageLink() *odata.Link

type ListEventInstancesOperationOptions

type ListEventInstancesOperationOptions struct {
	Count         *bool
	EndDateTime   *string
	Expand        *odata.Expand
	Filter        *string
	Metadata      *odata.Metadata
	OrderBy       *odata.OrderBy
	RetryFunc     client.RequestRetryFunc
	Search        *string
	Select        *[]string
	Skip          *int64
	StartDateTime *string
	Top           *int64
}

func DefaultListEventInstancesOperationOptions

func DefaultListEventInstancesOperationOptions() ListEventInstancesOperationOptions

func (ListEventInstancesOperationOptions) ToHeaders

func (ListEventInstancesOperationOptions) ToOData

func (ListEventInstancesOperationOptions) ToQuery

type ListEventInstancesOperationResponse

type ListEventInstancesOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]stable.Event
}

type SnoozeEventInstanceReminderOperationOptions

type SnoozeEventInstanceReminderOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
}

func DefaultSnoozeEventInstanceReminderOperationOptions

func DefaultSnoozeEventInstanceReminderOperationOptions() SnoozeEventInstanceReminderOperationOptions

func (SnoozeEventInstanceReminderOperationOptions) ToHeaders

func (SnoozeEventInstanceReminderOperationOptions) ToOData

func (SnoozeEventInstanceReminderOperationOptions) ToQuery

type SnoozeEventInstanceReminderOperationResponse

type SnoozeEventInstanceReminderOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type SnoozeEventInstanceReminderRequest

type SnoozeEventInstanceReminderRequest struct {
	NewReminderTime *stable.DateTimeTimeZone `json:"NewReminderTime,omitempty"`
}

type TentativelyAcceptEventInstanceOperationOptions

type TentativelyAcceptEventInstanceOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
}

func DefaultTentativelyAcceptEventInstanceOperationOptions

func DefaultTentativelyAcceptEventInstanceOperationOptions() TentativelyAcceptEventInstanceOperationOptions

func (TentativelyAcceptEventInstanceOperationOptions) ToHeaders

func (TentativelyAcceptEventInstanceOperationOptions) ToOData

func (TentativelyAcceptEventInstanceOperationOptions) ToQuery

type TentativelyAcceptEventInstanceOperationResponse

type TentativelyAcceptEventInstanceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type TentativelyAcceptEventInstanceRequest

type TentativelyAcceptEventInstanceRequest struct {
	Comment         nullable.Type[string] `json:"Comment,omitempty"`
	ProposedNewTime *stable.TimeSlot      `json:"ProposedNewTime,omitempty"`
	SendResponse    nullable.Type[bool]   `json:"SendResponse,omitempty"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL