event

package
v0.20241118.1115603 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/microsoft-graph/groups/stable/event Documentation

The event SDK allows for interaction with Microsoft Graph groups (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/groups/stable/event"

Client Initialization

client := event.NewEventClientWithBaseURI("https://graph.microsoft.com")
client.Client.Authorizer = authorizer

Example Usage: EventClient.AcceptEvent

ctx := context.TODO()
id := event.NewGroupIdEventID("groupId", "eventId")

payload := event.AcceptEventRequest{
	// ...
}


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

Example Usage: EventClient.CancelEvent

ctx := context.TODO()
id := event.NewGroupIdEventID("groupId", "eventId")

payload := event.CancelEventRequest{
	// ...
}


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

Example Usage: EventClient.CreateEvent

ctx := context.TODO()
id := event.NewGroupID("groupId")

payload := event.Event{
	// ...
}


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

Example Usage: EventClient.DeclineEvent

ctx := context.TODO()
id := event.NewGroupIdEventID("groupId", "eventId")

payload := event.DeclineEventRequest{
	// ...
}


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

Example Usage: EventClient.DeleteEvent

ctx := context.TODO()
id := event.NewGroupIdEventID("groupId", "eventId")

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

Example Usage: EventClient.DismissEventReminder

ctx := context.TODO()
id := event.NewGroupIdEventID("groupId", "eventId")

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

Example Usage: EventClient.ForwardEvent

ctx := context.TODO()
id := event.NewGroupIdEventID("groupId", "eventId")

payload := event.ForwardEventRequest{
	// ...
}


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

Example Usage: EventClient.GetEvent

ctx := context.TODO()
id := event.NewGroupIdEventID("groupId", "eventId")

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

Example Usage: EventClient.GetEventsCount

ctx := context.TODO()
id := event.NewGroupID("groupId")

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

Example Usage: EventClient.ListEvents

ctx := context.TODO()
id := event.NewGroupID("groupId")

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

Example Usage: EventClient.SnoozeEventReminder

ctx := context.TODO()
id := event.NewGroupIdEventID("groupId", "eventId")

payload := event.SnoozeEventReminderRequest{
	// ...
}


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

Example Usage: EventClient.TentativelyAcceptEvent

ctx := context.TODO()
id := event.NewGroupIdEventID("groupId", "eventId")

payload := event.TentativelyAcceptEventRequest{
	// ...
}


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

Example Usage: EventClient.UpdateEvent

ctx := context.TODO()
id := event.NewGroupIdEventID("groupId", "eventId")

payload := event.Event{
	// ...
}


read, err := client.UpdateEvent(ctx, id, payload, event.DefaultUpdateEventOperationOptions())
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 AcceptEventOperationOptions 

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

func DefaultAcceptEventOperationOptions 

func DefaultAcceptEventOperationOptions() AcceptEventOperationOptions

func (AcceptEventOperationOptions) ToHeaders 

func (o AcceptEventOperationOptions) ToHeaders() *client.Headers

func (AcceptEventOperationOptions) ToOData 

func (o AcceptEventOperationOptions) ToOData() *odata.Query

func (AcceptEventOperationOptions) ToQuery 

func (o AcceptEventOperationOptions) ToQuery() *client.QueryParams

type AcceptEventOperationResponse 

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

type AcceptEventRequest 

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

type CancelEventOperationOptions 

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

func DefaultCancelEventOperationOptions 

func DefaultCancelEventOperationOptions() CancelEventOperationOptions

func (CancelEventOperationOptions) ToHeaders 

func (o CancelEventOperationOptions) ToHeaders() *client.Headers

func (CancelEventOperationOptions) ToOData 

func (o CancelEventOperationOptions) ToOData() *odata.Query

func (CancelEventOperationOptions) ToQuery 

func (o CancelEventOperationOptions) ToQuery() *client.QueryParams

type CancelEventOperationResponse 

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

type CancelEventRequest 

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

type CreateEventOperationOptions 

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

func DefaultCreateEventOperationOptions 

func DefaultCreateEventOperationOptions() CreateEventOperationOptions

func (CreateEventOperationOptions) ToHeaders 

func (o CreateEventOperationOptions) ToHeaders() *client.Headers

func (CreateEventOperationOptions) ToOData 

func (o CreateEventOperationOptions) ToOData() *odata.Query

func (CreateEventOperationOptions) ToQuery 

func (o CreateEventOperationOptions) ToQuery() *client.QueryParams

type CreateEventOperationResponse 

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

type DeclineEventOperationOptions 

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

func DefaultDeclineEventOperationOptions 

func DefaultDeclineEventOperationOptions() DeclineEventOperationOptions

func (DeclineEventOperationOptions) ToHeaders 

func (o DeclineEventOperationOptions) ToHeaders() *client.Headers

func (DeclineEventOperationOptions) ToOData 

func (o DeclineEventOperationOptions) ToOData() *odata.Query

func (DeclineEventOperationOptions) ToQuery 

func (o DeclineEventOperationOptions) ToQuery() *client.QueryParams

type DeclineEventOperationResponse 

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

type DeclineEventRequest 

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

type DeleteEventOperationOptions 

type DeleteEventOperationOptions struct {
	IfMatch   *string
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
}

func DefaultDeleteEventOperationOptions 

func DefaultDeleteEventOperationOptions() DeleteEventOperationOptions

func (DeleteEventOperationOptions) ToHeaders 

func (o DeleteEventOperationOptions) ToHeaders() *client.Headers

func (DeleteEventOperationOptions) ToOData 

func (o DeleteEventOperationOptions) ToOData() *odata.Query

func (DeleteEventOperationOptions) ToQuery 

func (o DeleteEventOperationOptions) ToQuery() *client.QueryParams

type DeleteEventOperationResponse 

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

type DismissEventReminderOperationOptions 

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

func DefaultDismissEventReminderOperationOptions 

func DefaultDismissEventReminderOperationOptions() DismissEventReminderOperationOptions

func (DismissEventReminderOperationOptions) ToHeaders 

func (o DismissEventReminderOperationOptions) ToHeaders() *client.Headers

func (DismissEventReminderOperationOptions) ToOData 

func (o DismissEventReminderOperationOptions) ToOData() *odata.Query

func (DismissEventReminderOperationOptions) ToQuery 

func (o DismissEventReminderOperationOptions) ToQuery() *client.QueryParams

type DismissEventReminderOperationResponse 

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

type EventClient 

type EventClient struct {
	Client *msgraph.Client
}

func NewEventClientWithBaseURI 

func NewEventClientWithBaseURI(sdkApi sdkEnv.Api) (*EventClient, error)

func (EventClient) AcceptEvent 

func (c EventClient) AcceptEvent(ctx context.Context, id stable.GroupIdEventId, input AcceptEventRequest, options AcceptEventOperationOptions) (result AcceptEventOperationResponse, err error)

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

func (EventClient) CancelEvent 

func (c EventClient) CancelEvent(ctx context.Context, id stable.GroupIdEventId, input CancelEventRequest, options CancelEventOperationOptions) (result CancelEventOperationResponse, err error)

CancelEvent - 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 (EventClient) CreateEvent 

func (c EventClient) CreateEvent(ctx context.Context, id stable.GroupId, input stable.Event, options CreateEventOperationOptions) (result CreateEventOperationResponse, err error)

CreateEvent - Create event. Use this API to create a new event.

func (EventClient) DeclineEvent 

func (c EventClient) DeclineEvent(ctx context.Context, id stable.GroupIdEventId, input DeclineEventRequest, options DeclineEventOperationOptions) (result DeclineEventOperationResponse, err error)

DeclineEvent - 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 (EventClient) DeleteEvent 

func (c EventClient) DeleteEvent(ctx context.Context, id stable.GroupIdEventId, options DeleteEventOperationOptions) (result DeleteEventOperationResponse, err error)

DeleteEvent - Delete event. Delete an event object.

func (EventClient) DismissEventReminder 

func (c EventClient) DismissEventReminder(ctx context.Context, id stable.GroupIdEventId, options DismissEventReminderOperationOptions) (result DismissEventReminderOperationResponse, err error)

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

func (EventClient) ForwardEvent 

func (c EventClient) ForwardEvent(ctx context.Context, id stable.GroupIdEventId, input ForwardEventRequest, options ForwardEventOperationOptions) (result ForwardEventOperationResponse, err error)

ForwardEvent - 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 (EventClient) GetEvent 

func (c EventClient) GetEvent(ctx context.Context, id stable.GroupIdEventId, options GetEventOperationOptions) (result GetEventOperationResponse, err error)

GetEvent - Get event. Get an event object.

func (EventClient) GetEventsCount 

func (c EventClient) GetEventsCount(ctx context.Context, id stable.GroupId, options GetEventsCountOperationOptions) (result GetEventsCountOperationResponse, err error)

GetEventsCount - Get the number of the resource

func (EventClient) ListEvents 

func (c EventClient) ListEvents(ctx context.Context, id stable.GroupId, options ListEventsOperationOptions) (result ListEventsOperationResponse, err error)

ListEvents - List events. Retrieve a list of event objects.

func (EventClient) ListEventsComplete 

func (c EventClient) ListEventsComplete(ctx context.Context, id stable.GroupId, options ListEventsOperationOptions) (ListEventsCompleteResult, error)

ListEventsComplete retrieves all the results into a single object

func (EventClient) ListEventsCompleteMatchingPredicate 

func (c EventClient) ListEventsCompleteMatchingPredicate(ctx context.Context, id stable.GroupId, options ListEventsOperationOptions, predicate EventOperationPredicate) (result ListEventsCompleteResult, err error)

ListEventsCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (EventClient) SnoozeEventReminder 

func (c EventClient) SnoozeEventReminder(ctx context.Context, id stable.GroupIdEventId, input SnoozeEventReminderRequest, options SnoozeEventReminderOperationOptions) (result SnoozeEventReminderOperationResponse, err error)

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

func (EventClient) TentativelyAcceptEvent 

func (c EventClient) TentativelyAcceptEvent(ctx context.Context, id stable.GroupIdEventId, input TentativelyAcceptEventRequest, options TentativelyAcceptEventOperationOptions) (result TentativelyAcceptEventOperationResponse, err error)

TentativelyAcceptEvent - 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.

func (EventClient) UpdateEvent 

func (c EventClient) UpdateEvent(ctx context.Context, id stable.GroupIdEventId, input stable.Event, options UpdateEventOperationOptions) (result UpdateEventOperationResponse, err error)

UpdateEvent - Update the navigation property events in groups

type EventOperationPredicate 

type EventOperationPredicate struct {
}

func (EventOperationPredicate) Matches 

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

type ForwardEventOperationOptions 

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

func DefaultForwardEventOperationOptions 

func DefaultForwardEventOperationOptions() ForwardEventOperationOptions

func (ForwardEventOperationOptions) ToHeaders 

func (o ForwardEventOperationOptions) ToHeaders() *client.Headers

func (ForwardEventOperationOptions) ToOData 

func (o ForwardEventOperationOptions) ToOData() *odata.Query

func (ForwardEventOperationOptions) ToQuery 

func (o ForwardEventOperationOptions) ToQuery() *client.QueryParams

type ForwardEventOperationResponse 

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

type ForwardEventRequest 

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

type GetEventOperationOptions 

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

func DefaultGetEventOperationOptions 

func DefaultGetEventOperationOptions() GetEventOperationOptions

func (GetEventOperationOptions) ToHeaders 

func (o GetEventOperationOptions) ToHeaders() *client.Headers

func (GetEventOperationOptions) ToOData 

func (o GetEventOperationOptions) ToOData() *odata.Query

func (GetEventOperationOptions) ToQuery 

func (o GetEventOperationOptions) ToQuery() *client.QueryParams

type GetEventOperationResponse 

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

type GetEventsCountOperationOptions 

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

func DefaultGetEventsCountOperationOptions 

func DefaultGetEventsCountOperationOptions() GetEventsCountOperationOptions

func (GetEventsCountOperationOptions) ToHeaders 

func (o GetEventsCountOperationOptions) ToHeaders() *client.Headers

func (GetEventsCountOperationOptions) ToOData 

func (o GetEventsCountOperationOptions) ToOData() *odata.Query

func (GetEventsCountOperationOptions) ToQuery 

func (o GetEventsCountOperationOptions) ToQuery() *client.QueryParams

type GetEventsCountOperationResponse 

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

type ListEventsCompleteResult 

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

type ListEventsCustomPager 

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

type ListEventsOperationOptions 

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

func DefaultListEventsOperationOptions 

func DefaultListEventsOperationOptions() ListEventsOperationOptions

func (ListEventsOperationOptions) ToHeaders 

func (o ListEventsOperationOptions) ToHeaders() *client.Headers

func (ListEventsOperationOptions) ToOData 

func (o ListEventsOperationOptions) ToOData() *odata.Query

func (ListEventsOperationOptions) ToQuery 

func (o ListEventsOperationOptions) ToQuery() *client.QueryParams

type ListEventsOperationResponse 

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

type SnoozeEventReminderOperationOptions 

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

func DefaultSnoozeEventReminderOperationOptions 

func DefaultSnoozeEventReminderOperationOptions() SnoozeEventReminderOperationOptions

func (SnoozeEventReminderOperationOptions) ToHeaders 

func (o SnoozeEventReminderOperationOptions) ToHeaders() *client.Headers

func (SnoozeEventReminderOperationOptions) ToOData 

func (o SnoozeEventReminderOperationOptions) ToOData() *odata.Query

func (SnoozeEventReminderOperationOptions) ToQuery 

func (o SnoozeEventReminderOperationOptions) ToQuery() *client.QueryParams

type SnoozeEventReminderOperationResponse 

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

type SnoozeEventReminderRequest 

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

type TentativelyAcceptEventOperationOptions 

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

func DefaultTentativelyAcceptEventOperationOptions 

func DefaultTentativelyAcceptEventOperationOptions() TentativelyAcceptEventOperationOptions

func (TentativelyAcceptEventOperationOptions) ToHeaders 

func (o TentativelyAcceptEventOperationOptions) ToHeaders() *client.Headers

func (TentativelyAcceptEventOperationOptions) ToOData 

func (o TentativelyAcceptEventOperationOptions) ToOData() *odata.Query

func (TentativelyAcceptEventOperationOptions) ToQuery 

func (o TentativelyAcceptEventOperationOptions) ToQuery() *client.QueryParams

type TentativelyAcceptEventOperationResponse 

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

type TentativelyAcceptEventRequest 

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

type UpdateEventOperationOptions 

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

func DefaultUpdateEventOperationOptions 

func DefaultUpdateEventOperationOptions() UpdateEventOperationOptions

func (UpdateEventOperationOptions) ToHeaders 

func (o UpdateEventOperationOptions) ToHeaders() *client.Headers

func (UpdateEventOperationOptions) ToOData 

func (o UpdateEventOperationOptions) ToOData() *odata.Query

func (UpdateEventOperationOptions) ToQuery 

func (o UpdateEventOperationOptions) ToQuery() *client.QueryParams

type UpdateEventOperationResponse 

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

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.