siteonenotepage

package
v0.20241104.1140654 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/microsoft-graph/groups/beta/siteonenotepage Documentation

The siteonenotepage SDK allows for interaction with Microsoft Graph groups (API Version beta).

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/beta/siteonenotepage"

Client Initialization

client := siteonenotepage.NewSiteOnenotePageClientWithBaseURI("https://graph.microsoft.com")
client.Client.Authorizer = authorizer

Example Usage: SiteOnenotePageClient.CopySiteOnenotePageToSection

ctx := context.TODO()
id := siteonenotepage.NewGroupIdSiteIdOnenotePageID("groupId", "siteId", "onenotePageId")

payload := siteonenotepage.CopySiteOnenotePageToSectionRequest{
	// ...
}


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

Example Usage: SiteOnenotePageClient.CreateSiteOnenotePage

ctx := context.TODO()
id := siteonenotepage.NewGroupIdSiteID("groupId", "siteId")

payload := siteonenotepage.OnenotePage{
	// ...
}


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

Example Usage: SiteOnenotePageClient.CreateSiteOnenotePageOnenotePatchContent

ctx := context.TODO()
id := siteonenotepage.NewGroupIdSiteIdOnenotePageID("groupId", "siteId", "onenotePageId")

payload := siteonenotepage.CreateSiteOnenotePageOnenotePatchContentRequest{
	// ...
}


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

Example Usage: SiteOnenotePageClient.DeleteSiteOnenotePage

ctx := context.TODO()
id := siteonenotepage.NewGroupIdSiteIdOnenotePageID("groupId", "siteId", "onenotePageId")

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

Example Usage: SiteOnenotePageClient.GetSiteOnenotePage

ctx := context.TODO()
id := siteonenotepage.NewGroupIdSiteIdOnenotePageID("groupId", "siteId", "onenotePageId")

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

Example Usage: SiteOnenotePageClient.GetSiteOnenotePagesCount

ctx := context.TODO()
id := siteonenotepage.NewGroupIdSiteID("groupId", "siteId")

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

Example Usage: SiteOnenotePageClient.ListSiteOnenotePages

ctx := context.TODO()
id := siteonenotepage.NewGroupIdSiteID("groupId", "siteId")

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

Example Usage: SiteOnenotePageClient.UpdateSiteOnenotePage

ctx := context.TODO()
id := siteonenotepage.NewGroupIdSiteIdOnenotePageID("groupId", "siteId", "onenotePageId")

payload := siteonenotepage.OnenotePage{
	// ...
}


read, err := client.UpdateSiteOnenotePage(ctx, id, payload, siteonenotepage.DefaultUpdateSiteOnenotePageOperationOptions())
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 CopySiteOnenotePageToSectionOperationOptions 

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

func DefaultCopySiteOnenotePageToSectionOperationOptions 

func DefaultCopySiteOnenotePageToSectionOperationOptions() CopySiteOnenotePageToSectionOperationOptions

func (CopySiteOnenotePageToSectionOperationOptions) ToHeaders 

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

func (CopySiteOnenotePageToSectionOperationOptions) ToOData 

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

func (CopySiteOnenotePageToSectionOperationOptions) ToQuery 

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

type CopySiteOnenotePageToSectionOperationResponse 

type CopySiteOnenotePageToSectionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *beta.OnenoteOperation
}

type CopySiteOnenotePageToSectionRequest 

type CopySiteOnenotePageToSectionRequest struct {
	GroupId          nullable.Type[string] `json:"groupId,omitempty"`
	Id               nullable.Type[string] `json:"id,omitempty"`
	SiteCollectionId nullable.Type[string] `json:"siteCollectionId,omitempty"`
	SiteId           nullable.Type[string] `json:"siteId,omitempty"`
}

type CreateSiteOnenotePageOnenotePatchContentOperationOptions 

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

func DefaultCreateSiteOnenotePageOnenotePatchContentOperationOptions 

func DefaultCreateSiteOnenotePageOnenotePatchContentOperationOptions() CreateSiteOnenotePageOnenotePatchContentOperationOptions

func (CreateSiteOnenotePageOnenotePatchContentOperationOptions) ToHeaders 

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

func (CreateSiteOnenotePageOnenotePatchContentOperationOptions) ToOData 

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

func (CreateSiteOnenotePageOnenotePatchContentOperationOptions) ToQuery 

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

type CreateSiteOnenotePageOnenotePatchContentOperationResponse 

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

type CreateSiteOnenotePageOnenotePatchContentRequest 

type CreateSiteOnenotePageOnenotePatchContentRequest struct {
	Commands *[]beta.OnenotePatchContentCommand `json:"commands,omitempty"`
}

type CreateSiteOnenotePageOperationOptions 

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

func DefaultCreateSiteOnenotePageOperationOptions 

func DefaultCreateSiteOnenotePageOperationOptions() CreateSiteOnenotePageOperationOptions

func (CreateSiteOnenotePageOperationOptions) ToHeaders 

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

func (CreateSiteOnenotePageOperationOptions) ToOData 

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

func (CreateSiteOnenotePageOperationOptions) ToQuery 

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

type CreateSiteOnenotePageOperationResponse 

type CreateSiteOnenotePageOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *beta.OnenotePage
}

type DeleteSiteOnenotePageOperationOptions 

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

func DefaultDeleteSiteOnenotePageOperationOptions 

func DefaultDeleteSiteOnenotePageOperationOptions() DeleteSiteOnenotePageOperationOptions

func (DeleteSiteOnenotePageOperationOptions) ToHeaders 

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

func (DeleteSiteOnenotePageOperationOptions) ToOData 

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

func (DeleteSiteOnenotePageOperationOptions) ToQuery 

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

type DeleteSiteOnenotePageOperationResponse 

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

type GetSiteOnenotePageOperationOptions 

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

func DefaultGetSiteOnenotePageOperationOptions 

func DefaultGetSiteOnenotePageOperationOptions() GetSiteOnenotePageOperationOptions

func (GetSiteOnenotePageOperationOptions) ToHeaders 

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

func (GetSiteOnenotePageOperationOptions) ToOData 

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

func (GetSiteOnenotePageOperationOptions) ToQuery 

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

type GetSiteOnenotePageOperationResponse 

type GetSiteOnenotePageOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *beta.OnenotePage
}

type GetSiteOnenotePagesCountOperationOptions 

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

func DefaultGetSiteOnenotePagesCountOperationOptions 

func DefaultGetSiteOnenotePagesCountOperationOptions() GetSiteOnenotePagesCountOperationOptions

func (GetSiteOnenotePagesCountOperationOptions) ToHeaders 

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

func (GetSiteOnenotePagesCountOperationOptions) ToOData 

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

func (GetSiteOnenotePagesCountOperationOptions) ToQuery 

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

type GetSiteOnenotePagesCountOperationResponse 

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

type ListSiteOnenotePagesCompleteResult 

type ListSiteOnenotePagesCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []beta.OnenotePage
}

type ListSiteOnenotePagesCustomPager 

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

type ListSiteOnenotePagesOperationOptions 

type ListSiteOnenotePagesOperationOptions 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 DefaultListSiteOnenotePagesOperationOptions 

func DefaultListSiteOnenotePagesOperationOptions() ListSiteOnenotePagesOperationOptions

func (ListSiteOnenotePagesOperationOptions) ToHeaders 

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

func (ListSiteOnenotePagesOperationOptions) ToOData 

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

func (ListSiteOnenotePagesOperationOptions) ToQuery 

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

type ListSiteOnenotePagesOperationResponse 

type ListSiteOnenotePagesOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]beta.OnenotePage
}

type OnenotePageOperationPredicate 

type OnenotePageOperationPredicate struct {
}

func (OnenotePageOperationPredicate) Matches 

func (p OnenotePageOperationPredicate) Matches(input beta.OnenotePage) bool

type SiteOnenotePageClient 

type SiteOnenotePageClient struct {
	Client *msgraph.Client
}

func NewSiteOnenotePageClientWithBaseURI 

func NewSiteOnenotePageClientWithBaseURI(sdkApi sdkEnv.Api) (*SiteOnenotePageClient, error)

func (SiteOnenotePageClient) CopySiteOnenotePageToSection 

func (c SiteOnenotePageClient) CopySiteOnenotePageToSection(ctx context.Context, id beta.GroupIdSiteIdOnenotePageId, input CopySiteOnenotePageToSectionRequest, options CopySiteOnenotePageToSectionOperationOptions) (result CopySiteOnenotePageToSectionOperationResponse, err error)

CopySiteOnenotePageToSection - Invoke action copyToSection. Copy a page to a specific section. For copy operations, you follow an asynchronous calling pattern: First call the Copy action, and then poll the operation endpoint for the result.

func (SiteOnenotePageClient) CreateSiteOnenotePage 

func (c SiteOnenotePageClient) CreateSiteOnenotePage(ctx context.Context, id beta.GroupIdSiteId, input beta.OnenotePage, options CreateSiteOnenotePageOperationOptions) (result CreateSiteOnenotePageOperationResponse, err error)

CreateSiteOnenotePage - Create new navigation property to pages for groups

func (SiteOnenotePageClient) CreateSiteOnenotePageOnenotePatchContent 

func (c SiteOnenotePageClient) CreateSiteOnenotePageOnenotePatchContent(ctx context.Context, id beta.GroupIdSiteIdOnenotePageId, input CreateSiteOnenotePageOnenotePatchContentRequest, options CreateSiteOnenotePageOnenotePatchContentOperationOptions) (result CreateSiteOnenotePageOnenotePatchContentOperationResponse, err error)

CreateSiteOnenotePageOnenotePatchContent - Invoke action onenotePatchContent

func (SiteOnenotePageClient) DeleteSiteOnenotePage 

func (c SiteOnenotePageClient) DeleteSiteOnenotePage(ctx context.Context, id beta.GroupIdSiteIdOnenotePageId, options DeleteSiteOnenotePageOperationOptions) (result DeleteSiteOnenotePageOperationResponse, err error)

DeleteSiteOnenotePage - Delete navigation property pages for groups

func (SiteOnenotePageClient) GetSiteOnenotePage 

func (c SiteOnenotePageClient) GetSiteOnenotePage(ctx context.Context, id beta.GroupIdSiteIdOnenotePageId, options GetSiteOnenotePageOperationOptions) (result GetSiteOnenotePageOperationResponse, err error)

GetSiteOnenotePage - Get pages from groups. The pages in all OneNote notebooks that are owned by the user or group. Read-only. Nullable.

func (SiteOnenotePageClient) GetSiteOnenotePagesCount 

func (c SiteOnenotePageClient) GetSiteOnenotePagesCount(ctx context.Context, id beta.GroupIdSiteId, options GetSiteOnenotePagesCountOperationOptions) (result GetSiteOnenotePagesCountOperationResponse, err error)

GetSiteOnenotePagesCount - Get the number of the resource

func (SiteOnenotePageClient) ListSiteOnenotePages 

func (c SiteOnenotePageClient) ListSiteOnenotePages(ctx context.Context, id beta.GroupIdSiteId, options ListSiteOnenotePagesOperationOptions) (result ListSiteOnenotePagesOperationResponse, err error)

ListSiteOnenotePages - Get pages from groups. The pages in all OneNote notebooks that are owned by the user or group. Read-only. Nullable.

func (SiteOnenotePageClient) ListSiteOnenotePagesComplete 

func (c SiteOnenotePageClient) ListSiteOnenotePagesComplete(ctx context.Context, id beta.GroupIdSiteId, options ListSiteOnenotePagesOperationOptions) (ListSiteOnenotePagesCompleteResult, error)

ListSiteOnenotePagesComplete retrieves all the results into a single object

func (SiteOnenotePageClient) ListSiteOnenotePagesCompleteMatchingPredicate 

func (c SiteOnenotePageClient) ListSiteOnenotePagesCompleteMatchingPredicate(ctx context.Context, id beta.GroupIdSiteId, options ListSiteOnenotePagesOperationOptions, predicate OnenotePageOperationPredicate) (result ListSiteOnenotePagesCompleteResult, err error)

ListSiteOnenotePagesCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (SiteOnenotePageClient) UpdateSiteOnenotePage 

func (c SiteOnenotePageClient) UpdateSiteOnenotePage(ctx context.Context, id beta.GroupIdSiteIdOnenotePageId, input beta.OnenotePage, options UpdateSiteOnenotePageOperationOptions) (result UpdateSiteOnenotePageOperationResponse, err error)

UpdateSiteOnenotePage - Update the navigation property pages in groups

type UpdateSiteOnenotePageOperationOptions 

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

func DefaultUpdateSiteOnenotePageOperationOptions 

func DefaultUpdateSiteOnenotePageOperationOptions() UpdateSiteOnenotePageOperationOptions

func (UpdateSiteOnenotePageOperationOptions) ToHeaders 

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

func (UpdateSiteOnenotePageOperationOptions) ToOData 

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

func (UpdateSiteOnenotePageOperationOptions) ToQuery 

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

type UpdateSiteOnenotePageOperationResponse 

type UpdateSiteOnenotePageOperationResponse 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.