calendarevent

package
v0.20241025.1143247 Latest Latest
Warning

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

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

README

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

The calendarevent 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/calendarevent"

Client Initialization

client := calendarevent.NewCalendarEventClientWithBaseURI("https://graph.microsoft.com")
client.Client.Authorizer = authorizer

Example Usage: CalendarEventClient.AcceptCalendarEvent

ctx := context.TODO()
id := calendarevent.NewGroupIdCalendarEventID("groupId", "eventId")

payload := calendarevent.AcceptCalendarEventRequest{
	// ...
}


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

Example Usage: CalendarEventClient.CancelCalendarEvent

ctx := context.TODO()
id := calendarevent.NewGroupIdCalendarEventID("groupId", "eventId")

payload := calendarevent.CancelCalendarEventRequest{
	// ...
}


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

Example Usage: CalendarEventClient.CreateCalendarEvent

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

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


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

Example Usage: CalendarEventClient.DeclineCalendarEvent

ctx := context.TODO()
id := calendarevent.NewGroupIdCalendarEventID("groupId", "eventId")

payload := calendarevent.DeclineCalendarEventRequest{
	// ...
}


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

Example Usage: CalendarEventClient.DeleteCalendarEvent

ctx := context.TODO()
id := calendarevent.NewGroupIdCalendarEventID("groupId", "eventId")

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

Example Usage: CalendarEventClient.DismissCalendarEventReminder

ctx := context.TODO()
id := calendarevent.NewGroupIdCalendarEventID("groupId", "eventId")

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

Example Usage: CalendarEventClient.ForwardCalendarEvent

ctx := context.TODO()
id := calendarevent.NewGroupIdCalendarEventID("groupId", "eventId")

payload := calendarevent.ForwardCalendarEventRequest{
	// ...
}


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

Example Usage: CalendarEventClient.GetCalendarEvent

ctx := context.TODO()
id := calendarevent.NewGroupIdCalendarEventID("groupId", "eventId")

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

Example Usage: CalendarEventClient.GetCalendarEventsCount

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

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

Example Usage: CalendarEventClient.ListCalendarEvents

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

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

Example Usage: CalendarEventClient.SnoozeCalendarEventReminder

ctx := context.TODO()
id := calendarevent.NewGroupIdCalendarEventID("groupId", "eventId")

payload := calendarevent.SnoozeCalendarEventReminderRequest{
	// ...
}


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

Example Usage: CalendarEventClient.TentativelyAcceptCalendarEvent

ctx := context.TODO()
id := calendarevent.NewGroupIdCalendarEventID("groupId", "eventId")

payload := calendarevent.TentativelyAcceptCalendarEventRequest{
	// ...
}


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

Example Usage: CalendarEventClient.UpdateCalendarEvent

ctx := context.TODO()
id := calendarevent.NewGroupIdCalendarEventID("groupId", "eventId")

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


read, err := client.UpdateCalendarEvent(ctx, id, payload, calendarevent.DefaultUpdateCalendarEventOperationOptions())
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 AcceptCalendarEventOperationOptions

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

func DefaultAcceptCalendarEventOperationOptions

func DefaultAcceptCalendarEventOperationOptions() AcceptCalendarEventOperationOptions

func (AcceptCalendarEventOperationOptions) ToHeaders

func (AcceptCalendarEventOperationOptions) ToOData

func (AcceptCalendarEventOperationOptions) ToQuery

type AcceptCalendarEventOperationResponse

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

type AcceptCalendarEventRequest

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

type CalendarEventClient

type CalendarEventClient struct {
	Client *msgraph.Client
}

func NewCalendarEventClientWithBaseURI

func NewCalendarEventClientWithBaseURI(sdkApi sdkEnv.Api) (*CalendarEventClient, error)

func (CalendarEventClient) AcceptCalendarEvent

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

func (CalendarEventClient) CancelCalendarEvent

CancelCalendarEvent - 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 (CalendarEventClient) CreateCalendarEvent

CreateCalendarEvent - Create new navigation property to events for groups

func (CalendarEventClient) DeclineCalendarEvent

DeclineCalendarEvent - 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 (CalendarEventClient) DeleteCalendarEvent

DeleteCalendarEvent - Delete navigation property events for groups

func (CalendarEventClient) DismissCalendarEventReminder

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

func (CalendarEventClient) ForwardCalendarEvent

ForwardCalendarEvent - 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 (CalendarEventClient) GetCalendarEvent

GetCalendarEvent - Get events from groups. The events in the calendar. Navigation property. Read-only.

func (CalendarEventClient) GetCalendarEventsCount

GetCalendarEventsCount - Get the number of the resource

func (CalendarEventClient) ListCalendarEvents

ListCalendarEvents - Get events from groups. The events in the calendar. Navigation property. Read-only.

func (CalendarEventClient) ListCalendarEventsComplete

ListCalendarEventsComplete retrieves all the results into a single object

func (CalendarEventClient) ListCalendarEventsCompleteMatchingPredicate

func (c CalendarEventClient) ListCalendarEventsCompleteMatchingPredicate(ctx context.Context, id stable.GroupId, options ListCalendarEventsOperationOptions, predicate EventOperationPredicate) (result ListCalendarEventsCompleteResult, err error)

ListCalendarEventsCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (CalendarEventClient) SnoozeCalendarEventReminder

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

func (CalendarEventClient) TentativelyAcceptCalendarEvent

TentativelyAcceptCalendarEvent - 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 (CalendarEventClient) UpdateCalendarEvent

UpdateCalendarEvent - Update event. Update an event object.

type CancelCalendarEventOperationOptions

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

func DefaultCancelCalendarEventOperationOptions

func DefaultCancelCalendarEventOperationOptions() CancelCalendarEventOperationOptions

func (CancelCalendarEventOperationOptions) ToHeaders

func (CancelCalendarEventOperationOptions) ToOData

func (CancelCalendarEventOperationOptions) ToQuery

type CancelCalendarEventOperationResponse

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

type CancelCalendarEventRequest

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

type CreateCalendarEventOperationOptions

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

func DefaultCreateCalendarEventOperationOptions

func DefaultCreateCalendarEventOperationOptions() CreateCalendarEventOperationOptions

func (CreateCalendarEventOperationOptions) ToHeaders

func (CreateCalendarEventOperationOptions) ToOData

func (CreateCalendarEventOperationOptions) ToQuery

type CreateCalendarEventOperationResponse

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

type DeclineCalendarEventOperationOptions

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

func DefaultDeclineCalendarEventOperationOptions

func DefaultDeclineCalendarEventOperationOptions() DeclineCalendarEventOperationOptions

func (DeclineCalendarEventOperationOptions) ToHeaders

func (DeclineCalendarEventOperationOptions) ToOData

func (DeclineCalendarEventOperationOptions) ToQuery

type DeclineCalendarEventOperationResponse

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

type DeclineCalendarEventRequest

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

type DeleteCalendarEventOperationOptions

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

func DefaultDeleteCalendarEventOperationOptions

func DefaultDeleteCalendarEventOperationOptions() DeleteCalendarEventOperationOptions

func (DeleteCalendarEventOperationOptions) ToHeaders

func (DeleteCalendarEventOperationOptions) ToOData

func (DeleteCalendarEventOperationOptions) ToQuery

type DeleteCalendarEventOperationResponse

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

type DismissCalendarEventReminderOperationOptions

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

func DefaultDismissCalendarEventReminderOperationOptions

func DefaultDismissCalendarEventReminderOperationOptions() DismissCalendarEventReminderOperationOptions

func (DismissCalendarEventReminderOperationOptions) ToHeaders

func (DismissCalendarEventReminderOperationOptions) ToOData

func (DismissCalendarEventReminderOperationOptions) ToQuery

type DismissCalendarEventReminderOperationResponse

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

type EventOperationPredicate

type EventOperationPredicate struct {
}

func (EventOperationPredicate) Matches

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

type ForwardCalendarEventOperationOptions

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

func DefaultForwardCalendarEventOperationOptions

func DefaultForwardCalendarEventOperationOptions() ForwardCalendarEventOperationOptions

func (ForwardCalendarEventOperationOptions) ToHeaders

func (ForwardCalendarEventOperationOptions) ToOData

func (ForwardCalendarEventOperationOptions) ToQuery

type ForwardCalendarEventOperationResponse

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

type ForwardCalendarEventRequest

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

type GetCalendarEventOperationOptions

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

func DefaultGetCalendarEventOperationOptions

func DefaultGetCalendarEventOperationOptions() GetCalendarEventOperationOptions

func (GetCalendarEventOperationOptions) ToHeaders

func (GetCalendarEventOperationOptions) ToOData

func (GetCalendarEventOperationOptions) ToQuery

type GetCalendarEventOperationResponse

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

type GetCalendarEventsCountOperationOptions

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

func DefaultGetCalendarEventsCountOperationOptions

func DefaultGetCalendarEventsCountOperationOptions() GetCalendarEventsCountOperationOptions

func (GetCalendarEventsCountOperationOptions) ToHeaders

func (GetCalendarEventsCountOperationOptions) ToOData

func (GetCalendarEventsCountOperationOptions) ToQuery

type GetCalendarEventsCountOperationResponse

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

type ListCalendarEventsCompleteResult

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

type ListCalendarEventsCustomPager

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

type ListCalendarEventsOperationOptions

type ListCalendarEventsOperationOptions 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 DefaultListCalendarEventsOperationOptions

func DefaultListCalendarEventsOperationOptions() ListCalendarEventsOperationOptions

func (ListCalendarEventsOperationOptions) ToHeaders

func (ListCalendarEventsOperationOptions) ToOData

func (ListCalendarEventsOperationOptions) ToQuery

type ListCalendarEventsOperationResponse

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

type SnoozeCalendarEventReminderOperationOptions

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

func DefaultSnoozeCalendarEventReminderOperationOptions

func DefaultSnoozeCalendarEventReminderOperationOptions() SnoozeCalendarEventReminderOperationOptions

func (SnoozeCalendarEventReminderOperationOptions) ToHeaders

func (SnoozeCalendarEventReminderOperationOptions) ToOData

func (SnoozeCalendarEventReminderOperationOptions) ToQuery

type SnoozeCalendarEventReminderOperationResponse

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

type SnoozeCalendarEventReminderRequest

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

type TentativelyAcceptCalendarEventOperationOptions

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

func DefaultTentativelyAcceptCalendarEventOperationOptions

func DefaultTentativelyAcceptCalendarEventOperationOptions() TentativelyAcceptCalendarEventOperationOptions

func (TentativelyAcceptCalendarEventOperationOptions) ToHeaders

func (TentativelyAcceptCalendarEventOperationOptions) ToOData

func (TentativelyAcceptCalendarEventOperationOptions) ToQuery

type TentativelyAcceptCalendarEventOperationResponse

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

type TentativelyAcceptCalendarEventRequest

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

type UpdateCalendarEventOperationOptions

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

func DefaultUpdateCalendarEventOperationOptions

func DefaultUpdateCalendarEventOperationOptions() UpdateCalendarEventOperationOptions

func (UpdateCalendarEventOperationOptions) ToHeaders

func (UpdateCalendarEventOperationOptions) ToOData

func (UpdateCalendarEventOperationOptions) ToQuery

type UpdateCalendarEventOperationResponse

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

Jump to

Keyboard shortcuts

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