onenotepage

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

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

Client Initialization

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

Example Usage: OnenotePageClient.CopyOnenotePageToSection

ctx := context.TODO()
id := onenotepage.NewGroupIdOnenotePageID("groupId", "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.NewGroupID("groupId")

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.NewGroupIdOnenotePageID("groupId", "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.NewGroupIdOnenotePageID("groupId", "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.NewGroupIdOnenotePageID("groupId", "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.NewGroupID("groupId")

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.NewGroupID("groupId")

// 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.NewGroupIdOnenotePageID("groupId", "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 (CopyOnenotePageToSectionOperationOptions) ToOData

func (CopyOnenotePageToSectionOperationOptions) ToQuery

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 (CreateOnenotePageOnenotePatchContentOperationOptions) ToOData

func (CreateOnenotePageOnenotePatchContentOperationOptions) ToQuery

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 (CreateOnenotePageOperationOptions) ToOData

func (CreateOnenotePageOperationOptions) ToQuery

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 (DeleteOnenotePageOperationOptions) ToOData

func (DeleteOnenotePageOperationOptions) ToQuery

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 (GetOnenotePageOperationOptions) ToOData

func (GetOnenotePageOperationOptions) ToQuery

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 (GetOnenotePagesCountOperationOptions) ToOData

func (GetOnenotePagesCountOperationOptions) ToQuery

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 (ListOnenotePagesOperationOptions) ToOData

func (ListOnenotePagesOperationOptions) ToQuery

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

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

CreateOnenotePage - Create new navigation property to pages for groups

func (OnenotePageClient) CreateOnenotePageOnenotePatchContent

CreateOnenotePageOnenotePatchContent - Invoke action onenotePatchContent

func (OnenotePageClient) DeleteOnenotePage

DeleteOnenotePage - Delete navigation property pages for groups

func (OnenotePageClient) GetOnenotePage

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

func (OnenotePageClient) GetOnenotePagesCount

GetOnenotePagesCount - Get the number of the resource

func (OnenotePageClient) ListOnenotePages

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

func (OnenotePageClient) ListOnenotePagesComplete

ListOnenotePagesComplete retrieves all the results into a single object

func (OnenotePageClient) ListOnenotePagesCompleteMatchingPredicate

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

ListOnenotePagesCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (OnenotePageClient) UpdateOnenotePage

UpdateOnenotePage - Update the navigation property pages in groups

type OnenotePageOperationPredicate

type OnenotePageOperationPredicate struct {
}

func (OnenotePageOperationPredicate) Matches

type UpdateOnenotePageOperationOptions

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

func DefaultUpdateOnenotePageOperationOptions

func DefaultUpdateOnenotePageOperationOptions() UpdateOnenotePageOperationOptions

func (UpdateOnenotePageOperationOptions) ToHeaders

func (UpdateOnenotePageOperationOptions) ToOData

func (UpdateOnenotePageOperationOptions) ToQuery

type UpdateOnenotePageOperationResponse

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