onenotenotebook

package
v0.20241021.1074254 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/microsoft-graph/users/stable/onenotenotebook Documentation

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

Client Initialization

client := onenotenotebook.NewOnenoteNotebookClientWithBaseURI("https://graph.microsoft.com")
client.Client.Authorizer = authorizer

Example Usage: OnenoteNotebookClient.CopyOnenoteNotebookNotebook

ctx := context.TODO()
id := onenotenotebook.NewUserIdOnenoteNotebookID("userId", "notebookId")

payload := onenotenotebook.CopyOnenoteNotebookNotebookRequest{
	// ...
}


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

Example Usage: OnenoteNotebookClient.CreateOnenoteNotebook

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

payload := onenotenotebook.Notebook{
	// ...
}


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

Example Usage: OnenoteNotebookClient.DeleteOnenoteNotebook

ctx := context.TODO()
id := onenotenotebook.NewUserIdOnenoteNotebookID("userId", "notebookId")

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

Example Usage: OnenoteNotebookClient.GetOnenoteNotebook

ctx := context.TODO()
id := onenotenotebook.NewUserIdOnenoteNotebookID("userId", "notebookId")

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

Example Usage: OnenoteNotebookClient.GetOnenoteNotebooksCount

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

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

Example Usage: OnenoteNotebookClient.GetOnenoteNotebooksFromWebUrl

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

payload := onenotenotebook.GetOnenoteNotebooksFromWebUrlRequest{
	// ...
}


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

Example Usage: OnenoteNotebookClient.ListOnenoteNotebooks

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

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

Example Usage: OnenoteNotebookClient.UpdateOnenoteNotebook

ctx := context.TODO()
id := onenotenotebook.NewUserIdOnenoteNotebookID("userId", "notebookId")

payload := onenotenotebook.Notebook{
	// ...
}


read, err := client.UpdateOnenoteNotebook(ctx, id, payload, onenotenotebook.DefaultUpdateOnenoteNotebookOperationOptions())
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 CopyOnenoteNotebookNotebookOperationOptions 

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

func DefaultCopyOnenoteNotebookNotebookOperationOptions 

func DefaultCopyOnenoteNotebookNotebookOperationOptions() CopyOnenoteNotebookNotebookOperationOptions

func (CopyOnenoteNotebookNotebookOperationOptions) ToHeaders 

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

func (CopyOnenoteNotebookNotebookOperationOptions) ToOData 

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

func (CopyOnenoteNotebookNotebookOperationOptions) ToQuery 

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

type CopyOnenoteNotebookNotebookOperationResponse 

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

type CopyOnenoteNotebookNotebookRequest 

type CopyOnenoteNotebookNotebookRequest struct {
	GroupId          nullable.Type[string] `json:"groupId,omitempty"`
	NotebookFolder   nullable.Type[string] `json:"notebookFolder,omitempty"`
	RenameAs         nullable.Type[string] `json:"renameAs,omitempty"`
	SiteCollectionId nullable.Type[string] `json:"siteCollectionId,omitempty"`
	SiteId           nullable.Type[string] `json:"siteId,omitempty"`
}

type CreateOnenoteNotebookOperationOptions 

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

func DefaultCreateOnenoteNotebookOperationOptions 

func DefaultCreateOnenoteNotebookOperationOptions() CreateOnenoteNotebookOperationOptions

func (CreateOnenoteNotebookOperationOptions) ToHeaders 

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

func (CreateOnenoteNotebookOperationOptions) ToOData 

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

func (CreateOnenoteNotebookOperationOptions) ToQuery 

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

type CreateOnenoteNotebookOperationResponse 

type CreateOnenoteNotebookOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *stable.Notebook
}

type DeleteOnenoteNotebookOperationOptions 

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

func DefaultDeleteOnenoteNotebookOperationOptions 

func DefaultDeleteOnenoteNotebookOperationOptions() DeleteOnenoteNotebookOperationOptions

func (DeleteOnenoteNotebookOperationOptions) ToHeaders 

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

func (DeleteOnenoteNotebookOperationOptions) ToOData 

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

func (DeleteOnenoteNotebookOperationOptions) ToQuery 

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

type DeleteOnenoteNotebookOperationResponse 

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

type GetOnenoteNotebookOperationOptions 

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

func DefaultGetOnenoteNotebookOperationOptions 

func DefaultGetOnenoteNotebookOperationOptions() GetOnenoteNotebookOperationOptions

func (GetOnenoteNotebookOperationOptions) ToHeaders 

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

func (GetOnenoteNotebookOperationOptions) ToOData 

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

func (GetOnenoteNotebookOperationOptions) ToQuery 

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

type GetOnenoteNotebookOperationResponse 

type GetOnenoteNotebookOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *stable.Notebook
}

type GetOnenoteNotebooksCountOperationOptions 

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

func DefaultGetOnenoteNotebooksCountOperationOptions 

func DefaultGetOnenoteNotebooksCountOperationOptions() GetOnenoteNotebooksCountOperationOptions

func (GetOnenoteNotebooksCountOperationOptions) ToHeaders 

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

func (GetOnenoteNotebooksCountOperationOptions) ToOData 

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

func (GetOnenoteNotebooksCountOperationOptions) ToQuery 

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

type GetOnenoteNotebooksCountOperationResponse 

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

type GetOnenoteNotebooksFromWebUrlOperationOptions 

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

func DefaultGetOnenoteNotebooksFromWebUrlOperationOptions 

func DefaultGetOnenoteNotebooksFromWebUrlOperationOptions() GetOnenoteNotebooksFromWebUrlOperationOptions

func (GetOnenoteNotebooksFromWebUrlOperationOptions) ToHeaders 

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

func (GetOnenoteNotebooksFromWebUrlOperationOptions) ToOData 

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

func (GetOnenoteNotebooksFromWebUrlOperationOptions) ToQuery 

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

type GetOnenoteNotebooksFromWebUrlOperationResponse 

type GetOnenoteNotebooksFromWebUrlOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *stable.CopyNotebookModel
}

type GetOnenoteNotebooksFromWebUrlRequest 

type GetOnenoteNotebooksFromWebUrlRequest struct {
	WebUrl nullable.Type[string] `json:"webUrl,omitempty"`
}

type ListOnenoteNotebooksCompleteResult 

type ListOnenoteNotebooksCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []stable.Notebook
}

type ListOnenoteNotebooksCustomPager 

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

type ListOnenoteNotebooksOperationOptions 

type ListOnenoteNotebooksOperationOptions 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 DefaultListOnenoteNotebooksOperationOptions 

func DefaultListOnenoteNotebooksOperationOptions() ListOnenoteNotebooksOperationOptions

func (ListOnenoteNotebooksOperationOptions) ToHeaders 

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

func (ListOnenoteNotebooksOperationOptions) ToOData 

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

func (ListOnenoteNotebooksOperationOptions) ToQuery 

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

type ListOnenoteNotebooksOperationResponse 

type ListOnenoteNotebooksOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]stable.Notebook
}

type NotebookOperationPredicate 

type NotebookOperationPredicate struct {
}

func (NotebookOperationPredicate) Matches 

func (p NotebookOperationPredicate) Matches(input stable.Notebook) bool

type OnenoteNotebookClient 

type OnenoteNotebookClient struct {
	Client *msgraph.Client
}

func NewOnenoteNotebookClientWithBaseURI 

func NewOnenoteNotebookClientWithBaseURI(sdkApi sdkEnv.Api) (*OnenoteNotebookClient, error)

func (OnenoteNotebookClient) CopyOnenoteNotebookNotebook 

func (c OnenoteNotebookClient) CopyOnenoteNotebookNotebook(ctx context.Context, id stable.UserIdOnenoteNotebookId, input CopyOnenoteNotebookNotebookRequest, options CopyOnenoteNotebookNotebookOperationOptions) (result CopyOnenoteNotebookNotebookOperationResponse, err error)

CopyOnenoteNotebookNotebook - Invoke action copyNotebook. For Copy operations, you follow an asynchronous calling pattern: First call the Copy action, and then poll the operation endpoint for the result.

func (OnenoteNotebookClient) CreateOnenoteNotebook 

func (c OnenoteNotebookClient) CreateOnenoteNotebook(ctx context.Context, id stable.UserId, input stable.Notebook, options CreateOnenoteNotebookOperationOptions) (result CreateOnenoteNotebookOperationResponse, err error)

CreateOnenoteNotebook - Create new navigation property to notebooks for users

func (OnenoteNotebookClient) DeleteOnenoteNotebook 

func (c OnenoteNotebookClient) DeleteOnenoteNotebook(ctx context.Context, id stable.UserIdOnenoteNotebookId, options DeleteOnenoteNotebookOperationOptions) (result DeleteOnenoteNotebookOperationResponse, err error)

DeleteOnenoteNotebook - Delete navigation property notebooks for users

func (OnenoteNotebookClient) GetOnenoteNotebook 

func (c OnenoteNotebookClient) GetOnenoteNotebook(ctx context.Context, id stable.UserIdOnenoteNotebookId, options GetOnenoteNotebookOperationOptions) (result GetOnenoteNotebookOperationResponse, err error)

GetOnenoteNotebook - Get notebooks from users. The collection of OneNote notebooks that are owned by the user or group. Read-only. Nullable.

func (OnenoteNotebookClient) GetOnenoteNotebooksCount 

func (c OnenoteNotebookClient) GetOnenoteNotebooksCount(ctx context.Context, id stable.UserId, options GetOnenoteNotebooksCountOperationOptions) (result GetOnenoteNotebooksCountOperationResponse, err error)

GetOnenoteNotebooksCount - Get the number of the resource

func (OnenoteNotebookClient) GetOnenoteNotebooksFromWebUrl 

func (c OnenoteNotebookClient) GetOnenoteNotebooksFromWebUrl(ctx context.Context, id stable.UserId, input GetOnenoteNotebooksFromWebUrlRequest, options GetOnenoteNotebooksFromWebUrlOperationOptions) (result GetOnenoteNotebooksFromWebUrlOperationResponse, err error)

GetOnenoteNotebooksFromWebUrl - Invoke action getNotebookFromWebUrl. Retrieve the properties and relationships of a notebook object by using its URL path. The location can be user notebooks on Microsoft 365, group notebooks, or SharePoint site-hosted team notebooks on Microsoft 365.

func (OnenoteNotebookClient) ListOnenoteNotebooks 

func (c OnenoteNotebookClient) ListOnenoteNotebooks(ctx context.Context, id stable.UserId, options ListOnenoteNotebooksOperationOptions) (result ListOnenoteNotebooksOperationResponse, err error)

ListOnenoteNotebooks - Get notebooks from users. The collection of OneNote notebooks that are owned by the user or group. Read-only. Nullable.

func (OnenoteNotebookClient) ListOnenoteNotebooksComplete 

func (c OnenoteNotebookClient) ListOnenoteNotebooksComplete(ctx context.Context, id stable.UserId, options ListOnenoteNotebooksOperationOptions) (ListOnenoteNotebooksCompleteResult, error)

ListOnenoteNotebooksComplete retrieves all the results into a single object

func (OnenoteNotebookClient) ListOnenoteNotebooksCompleteMatchingPredicate 

func (c OnenoteNotebookClient) ListOnenoteNotebooksCompleteMatchingPredicate(ctx context.Context, id stable.UserId, options ListOnenoteNotebooksOperationOptions, predicate NotebookOperationPredicate) (result ListOnenoteNotebooksCompleteResult, err error)

ListOnenoteNotebooksCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (OnenoteNotebookClient) UpdateOnenoteNotebook 

func (c OnenoteNotebookClient) UpdateOnenoteNotebook(ctx context.Context, id stable.UserIdOnenoteNotebookId, input stable.Notebook, options UpdateOnenoteNotebookOperationOptions) (result UpdateOnenoteNotebookOperationResponse, err error)

UpdateOnenoteNotebook - Update the navigation property notebooks in users

type UpdateOnenoteNotebookOperationOptions 

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

func DefaultUpdateOnenoteNotebookOperationOptions 

func DefaultUpdateOnenoteNotebookOperationOptions() UpdateOnenoteNotebookOperationOptions

func (UpdateOnenoteNotebookOperationOptions) ToHeaders 

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

func (UpdateOnenoteNotebookOperationOptions) ToOData 

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

func (UpdateOnenoteNotebookOperationOptions) ToQuery 

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

type UpdateOnenoteNotebookOperationResponse 

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