onenotenotebook

package
v0.20241212.1154051 Latest Latest
Warning

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

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

README

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

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

Client Initialization

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

Example Usage: OnenoteNotebookClient.CopyOnenoteNotebookNotebook

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

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

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

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

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

func (CopyOnenoteNotebookNotebookOperationOptions) ToQuery

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

func (CreateOnenoteNotebookOperationOptions) ToQuery

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

func (DeleteOnenoteNotebookOperationOptions) ToQuery

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

func (GetOnenoteNotebookOperationOptions) ToQuery

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

func (GetOnenoteNotebooksCountOperationOptions) ToQuery

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

func (GetOnenoteNotebooksFromWebUrlOperationOptions) ToQuery

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

func (ListOnenoteNotebooksOperationOptions) ToQuery

type ListOnenoteNotebooksOperationResponse

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

type NotebookOperationPredicate

type NotebookOperationPredicate struct {
}

func (NotebookOperationPredicate) Matches

type OnenoteNotebookClient

type OnenoteNotebookClient struct {
	Client *msgraph.Client
}

func NewOnenoteNotebookClientWithBaseURI

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

func (OnenoteNotebookClient) CopyOnenoteNotebookNotebook

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

CreateOnenoteNotebook - Create new navigation property to notebooks for groups

func (OnenoteNotebookClient) DeleteOnenoteNotebook

DeleteOnenoteNotebook - Delete navigation property notebooks for groups

func (OnenoteNotebookClient) GetOnenoteNotebook

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

func (OnenoteNotebookClient) GetOnenoteNotebooksCount

GetOnenoteNotebooksCount - Get the number of the resource

func (OnenoteNotebookClient) GetOnenoteNotebooksFromWebUrl

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

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

func (OnenoteNotebookClient) ListOnenoteNotebooksComplete

ListOnenoteNotebooksComplete retrieves all the results into a single object

func (OnenoteNotebookClient) ListOnenoteNotebooksCompleteMatchingPredicate

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

ListOnenoteNotebooksCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (OnenoteNotebookClient) UpdateOnenoteNotebook

UpdateOnenoteNotebook - Update the navigation property notebooks in groups

type UpdateOnenoteNotebookOperationOptions

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

func DefaultUpdateOnenoteNotebookOperationOptions

func DefaultUpdateOnenoteNotebookOperationOptions() UpdateOnenoteNotebookOperationOptions

func (UpdateOnenoteNotebookOperationOptions) ToHeaders

func (UpdateOnenoteNotebookOperationOptions) ToOData

func (UpdateOnenoteNotebookOperationOptions) ToQuery

type UpdateOnenoteNotebookOperationResponse

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