onenotepage

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/users/stable/onenotepage Documentation

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

Client Initialization

client := onenotepage.NewOnenotePageClientWithBaseURI("https://graph.microsoft.com")
client.Client.Authorizer = authorizer

Example Usage: OnenotePageClient.CopyOnenotePageToSection

ctx := context.TODO()
id := onenotepage.NewUserIdOnenotePageID("userId", "onenotePageId")

payload := onenotepage.CopyOnenotePageToSectionRequest{
	// ...
}


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

Example Usage: OnenotePageClient.CreateOnenotePage

ctx := context.TODO()
id := onenotepage.NewUserID("userId")

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


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

Example Usage: OnenotePageClient.CreateOnenotePageOnenotePatchContent

ctx := context.TODO()
id := onenotepage.NewUserIdOnenotePageID("userId", "onenotePageId")

payload := onenotepage.CreateOnenotePageOnenotePatchContentRequest{
	// ...
}


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

Example Usage: OnenotePageClient.DeleteOnenotePage

ctx := context.TODO()
id := onenotepage.NewUserIdOnenotePageID("userId", "onenotePageId")

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

Example Usage: OnenotePageClient.GetOnenotePage

ctx := context.TODO()
id := onenotepage.NewUserIdOnenotePageID("userId", "onenotePageId")

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

Example Usage: OnenotePageClient.GetOnenotePagesCount

ctx := context.TODO()
id := onenotepage.NewUserID("userId")

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

Example Usage: OnenotePageClient.ListOnenotePages

ctx := context.TODO()
id := onenotepage.NewUserID("userId")

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

Example Usage: OnenotePageClient.UpdateOnenotePage

ctx := context.TODO()
id := onenotepage.NewUserIdOnenotePageID("userId", "onenotePageId")

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


read, err := client.UpdateOnenotePage(ctx, id, payload, onenotepage.DefaultUpdateOnenotePageOperationOptions())
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 CopyOnenotePageToSectionOperationOptions 

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

func DefaultCopyOnenotePageToSectionOperationOptions 

func DefaultCopyOnenotePageToSectionOperationOptions() CopyOnenotePageToSectionOperationOptions

func (CopyOnenotePageToSectionOperationOptions) ToHeaders 

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

func (CopyOnenotePageToSectionOperationOptions) ToOData 

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

func (CopyOnenotePageToSectionOperationOptions) ToQuery 

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

type CopyOnenotePageToSectionOperationResponse 

type CopyOnenotePageToSectionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *stable.OnenoteOperation
}

type CopyOnenotePageToSectionRequest 

type CopyOnenotePageToSectionRequest 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 CreateOnenotePageOnenotePatchContentOperationOptions 

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

func DefaultCreateOnenotePageOnenotePatchContentOperationOptions 

func DefaultCreateOnenotePageOnenotePatchContentOperationOptions() CreateOnenotePageOnenotePatchContentOperationOptions

func (CreateOnenotePageOnenotePatchContentOperationOptions) ToHeaders 

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

func (CreateOnenotePageOnenotePatchContentOperationOptions) ToOData 

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

func (CreateOnenotePageOnenotePatchContentOperationOptions) ToQuery 

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

type CreateOnenotePageOnenotePatchContentOperationResponse 

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

type CreateOnenotePageOnenotePatchContentRequest 

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

type CreateOnenotePageOperationOptions 

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

func DefaultCreateOnenotePageOperationOptions 

func DefaultCreateOnenotePageOperationOptions() CreateOnenotePageOperationOptions

func (CreateOnenotePageOperationOptions) ToHeaders 

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

func (CreateOnenotePageOperationOptions) ToOData 

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

func (CreateOnenotePageOperationOptions) ToQuery 

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

type CreateOnenotePageOperationResponse 

type CreateOnenotePageOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *stable.OnenotePage
}

type DeleteOnenotePageOperationOptions 

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

func DefaultDeleteOnenotePageOperationOptions 

func DefaultDeleteOnenotePageOperationOptions() DeleteOnenotePageOperationOptions

func (DeleteOnenotePageOperationOptions) ToHeaders 

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

func (DeleteOnenotePageOperationOptions) ToOData 

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

func (DeleteOnenotePageOperationOptions) ToQuery 

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

type DeleteOnenotePageOperationResponse 

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

type GetOnenotePageOperationOptions 

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

func DefaultGetOnenotePageOperationOptions 

func DefaultGetOnenotePageOperationOptions() GetOnenotePageOperationOptions

func (GetOnenotePageOperationOptions) ToHeaders 

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

func (GetOnenotePageOperationOptions) ToOData 

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

func (GetOnenotePageOperationOptions) ToQuery 

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

type GetOnenotePageOperationResponse 

type GetOnenotePageOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *stable.OnenotePage
}

type GetOnenotePagesCountOperationOptions 

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

func DefaultGetOnenotePagesCountOperationOptions 

func DefaultGetOnenotePagesCountOperationOptions() GetOnenotePagesCountOperationOptions

func (GetOnenotePagesCountOperationOptions) ToHeaders 

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

func (GetOnenotePagesCountOperationOptions) ToOData 

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

func (GetOnenotePagesCountOperationOptions) ToQuery 

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

type GetOnenotePagesCountOperationResponse 

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

type ListOnenotePagesCompleteResult 

type ListOnenotePagesCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []stable.OnenotePage
}

type ListOnenotePagesCustomPager 

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

type ListOnenotePagesOperationOptions 

type ListOnenotePagesOperationOptions 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 DefaultListOnenotePagesOperationOptions 

func DefaultListOnenotePagesOperationOptions() ListOnenotePagesOperationOptions

func (ListOnenotePagesOperationOptions) ToHeaders 

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

func (ListOnenotePagesOperationOptions) ToOData 

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

func (ListOnenotePagesOperationOptions) ToQuery 

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

type ListOnenotePagesOperationResponse 

type ListOnenotePagesOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]stable.OnenotePage
}

type OnenotePageClient 

type OnenotePageClient struct {
	Client *msgraph.Client
}

func NewOnenotePageClientWithBaseURI 

func NewOnenotePageClientWithBaseURI(sdkApi sdkEnv.Api) (*OnenotePageClient, error)

func (OnenotePageClient) CopyOnenotePageToSection 

func (c OnenotePageClient) CopyOnenotePageToSection(ctx context.Context, id stable.UserIdOnenotePageId, input CopyOnenotePageToSectionRequest, options CopyOnenotePageToSectionOperationOptions) (result CopyOnenotePageToSectionOperationResponse, err error)

CopyOnenotePageToSection - 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 (OnenotePageClient) CreateOnenotePage 

func (c OnenotePageClient) CreateOnenotePage(ctx context.Context, id stable.UserId, input stable.OnenotePage, options CreateOnenotePageOperationOptions) (result CreateOnenotePageOperationResponse, err error)

CreateOnenotePage - Create new navigation property to pages for users

func (OnenotePageClient) CreateOnenotePageOnenotePatchContent 

func (c OnenotePageClient) CreateOnenotePageOnenotePatchContent(ctx context.Context, id stable.UserIdOnenotePageId, input CreateOnenotePageOnenotePatchContentRequest, options CreateOnenotePageOnenotePatchContentOperationOptions) (result CreateOnenotePageOnenotePatchContentOperationResponse, err error)

CreateOnenotePageOnenotePatchContent - Invoke action onenotePatchContent

func (OnenotePageClient) DeleteOnenotePage 

func (c OnenotePageClient) DeleteOnenotePage(ctx context.Context, id stable.UserIdOnenotePageId, options DeleteOnenotePageOperationOptions) (result DeleteOnenotePageOperationResponse, err error)

DeleteOnenotePage - Delete navigation property pages for users

func (OnenotePageClient) GetOnenotePage 

func (c OnenotePageClient) GetOnenotePage(ctx context.Context, id stable.UserIdOnenotePageId, options GetOnenotePageOperationOptions) (result GetOnenotePageOperationResponse, err error)

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

func (OnenotePageClient) GetOnenotePagesCount 

func (c OnenotePageClient) GetOnenotePagesCount(ctx context.Context, id stable.UserId, options GetOnenotePagesCountOperationOptions) (result GetOnenotePagesCountOperationResponse, err error)

GetOnenotePagesCount - Get the number of the resource

func (OnenotePageClient) ListOnenotePages 

func (c OnenotePageClient) ListOnenotePages(ctx context.Context, id stable.UserId, options ListOnenotePagesOperationOptions) (result ListOnenotePagesOperationResponse, err error)

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

func (OnenotePageClient) ListOnenotePagesComplete 

func (c OnenotePageClient) ListOnenotePagesComplete(ctx context.Context, id stable.UserId, options ListOnenotePagesOperationOptions) (ListOnenotePagesCompleteResult, error)

ListOnenotePagesComplete retrieves all the results into a single object

func (OnenotePageClient) ListOnenotePagesCompleteMatchingPredicate 

func (c OnenotePageClient) ListOnenotePagesCompleteMatchingPredicate(ctx context.Context, id stable.UserId, options ListOnenotePagesOperationOptions, predicate OnenotePageOperationPredicate) (result ListOnenotePagesCompleteResult, err error)

ListOnenotePagesCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (OnenotePageClient) UpdateOnenotePage 

func (c OnenotePageClient) UpdateOnenotePage(ctx context.Context, id stable.UserIdOnenotePageId, input stable.OnenotePage, options UpdateOnenotePageOperationOptions) (result UpdateOnenotePageOperationResponse, err error)

UpdateOnenotePage - Update the navigation property pages in users

type OnenotePageOperationPredicate 

type OnenotePageOperationPredicate struct {
}

func (OnenotePageOperationPredicate) Matches 

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

type UpdateOnenotePageOperationOptions 

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

func DefaultUpdateOnenotePageOperationOptions 

func DefaultUpdateOnenotePageOperationOptions() UpdateOnenotePageOperationOptions

func (UpdateOnenotePageOperationOptions) ToHeaders 

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

func (UpdateOnenotePageOperationOptions) ToOData 

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

func (UpdateOnenotePageOperationOptions) ToQuery 

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

type UpdateOnenotePageOperationResponse 

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