siteonenotenotebook

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: 0

README

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

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

Client Initialization

client := siteonenotenotebook.NewSiteOnenoteNotebookClientWithBaseURI("https://graph.microsoft.com")
client.Client.Authorizer = authorizer

Example Usage: SiteOnenoteNotebookClient.CopySiteOnenoteNotebookNotebook

ctx := context.TODO()
id := siteonenotenotebook.NewGroupIdSiteIdOnenoteNotebookID("groupId", "siteId", "notebookId")

payload := siteonenotenotebook.CopySiteOnenoteNotebookNotebookRequest{
	// ...
}


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

Example Usage: SiteOnenoteNotebookClient.CreateSiteOnenoteNotebook

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

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


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

Example Usage: SiteOnenoteNotebookClient.DeleteSiteOnenoteNotebook

ctx := context.TODO()
id := siteonenotenotebook.NewGroupIdSiteIdOnenoteNotebookID("groupId", "siteId", "notebookId")

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

Example Usage: SiteOnenoteNotebookClient.GetSiteOnenoteNotebook

ctx := context.TODO()
id := siteonenotenotebook.NewGroupIdSiteIdOnenoteNotebookID("groupId", "siteId", "notebookId")

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

Example Usage: SiteOnenoteNotebookClient.GetSiteOnenoteNotebooksCount

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

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

Example Usage: SiteOnenoteNotebookClient.GetSiteOnenoteNotebooksFromWebUrl

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

payload := siteonenotenotebook.GetSiteOnenoteNotebooksFromWebUrlRequest{
	// ...
}


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

Example Usage: SiteOnenoteNotebookClient.ListSiteOnenoteNotebooks

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

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

Example Usage: SiteOnenoteNotebookClient.UpdateSiteOnenoteNotebook

ctx := context.TODO()
id := siteonenotenotebook.NewGroupIdSiteIdOnenoteNotebookID("groupId", "siteId", "notebookId")

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


read, err := client.UpdateSiteOnenoteNotebook(ctx, id, payload, siteonenotenotebook.DefaultUpdateSiteOnenoteNotebookOperationOptions())
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 CopySiteOnenoteNotebookNotebookOperationOptions 

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

func DefaultCopySiteOnenoteNotebookNotebookOperationOptions 

func DefaultCopySiteOnenoteNotebookNotebookOperationOptions() CopySiteOnenoteNotebookNotebookOperationOptions

func (CopySiteOnenoteNotebookNotebookOperationOptions) ToHeaders 

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

func (CopySiteOnenoteNotebookNotebookOperationOptions) ToOData 

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

func (CopySiteOnenoteNotebookNotebookOperationOptions) ToQuery 

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

type CopySiteOnenoteNotebookNotebookOperationResponse 

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

type CopySiteOnenoteNotebookNotebookRequest 

type CopySiteOnenoteNotebookNotebookRequest 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 CreateSiteOnenoteNotebookOperationOptions 

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

func DefaultCreateSiteOnenoteNotebookOperationOptions 

func DefaultCreateSiteOnenoteNotebookOperationOptions() CreateSiteOnenoteNotebookOperationOptions

func (CreateSiteOnenoteNotebookOperationOptions) ToHeaders 

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

func (CreateSiteOnenoteNotebookOperationOptions) ToOData 

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

func (CreateSiteOnenoteNotebookOperationOptions) ToQuery 

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

type CreateSiteOnenoteNotebookOperationResponse 

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

type DeleteSiteOnenoteNotebookOperationOptions 

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

func DefaultDeleteSiteOnenoteNotebookOperationOptions 

func DefaultDeleteSiteOnenoteNotebookOperationOptions() DeleteSiteOnenoteNotebookOperationOptions

func (DeleteSiteOnenoteNotebookOperationOptions) ToHeaders 

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

func (DeleteSiteOnenoteNotebookOperationOptions) ToOData 

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

func (DeleteSiteOnenoteNotebookOperationOptions) ToQuery 

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

type DeleteSiteOnenoteNotebookOperationResponse 

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

type GetSiteOnenoteNotebookOperationOptions 

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

func DefaultGetSiteOnenoteNotebookOperationOptions 

func DefaultGetSiteOnenoteNotebookOperationOptions() GetSiteOnenoteNotebookOperationOptions

func (GetSiteOnenoteNotebookOperationOptions) ToHeaders 

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

func (GetSiteOnenoteNotebookOperationOptions) ToOData 

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

func (GetSiteOnenoteNotebookOperationOptions) ToQuery 

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

type GetSiteOnenoteNotebookOperationResponse 

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

type GetSiteOnenoteNotebooksCountOperationOptions 

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

func DefaultGetSiteOnenoteNotebooksCountOperationOptions 

func DefaultGetSiteOnenoteNotebooksCountOperationOptions() GetSiteOnenoteNotebooksCountOperationOptions

func (GetSiteOnenoteNotebooksCountOperationOptions) ToHeaders 

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

func (GetSiteOnenoteNotebooksCountOperationOptions) ToOData 

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

func (GetSiteOnenoteNotebooksCountOperationOptions) ToQuery 

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

type GetSiteOnenoteNotebooksCountOperationResponse 

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

type GetSiteOnenoteNotebooksFromWebUrlOperationOptions 

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

func DefaultGetSiteOnenoteNotebooksFromWebUrlOperationOptions 

func DefaultGetSiteOnenoteNotebooksFromWebUrlOperationOptions() GetSiteOnenoteNotebooksFromWebUrlOperationOptions

func (GetSiteOnenoteNotebooksFromWebUrlOperationOptions) ToHeaders 

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

func (GetSiteOnenoteNotebooksFromWebUrlOperationOptions) ToOData 

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

func (GetSiteOnenoteNotebooksFromWebUrlOperationOptions) ToQuery 

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

type GetSiteOnenoteNotebooksFromWebUrlOperationResponse 

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

type GetSiteOnenoteNotebooksFromWebUrlRequest 

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

type ListSiteOnenoteNotebooksCompleteResult 

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

type ListSiteOnenoteNotebooksCustomPager 

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

type ListSiteOnenoteNotebooksOperationOptions 

type ListSiteOnenoteNotebooksOperationOptions 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 DefaultListSiteOnenoteNotebooksOperationOptions 

func DefaultListSiteOnenoteNotebooksOperationOptions() ListSiteOnenoteNotebooksOperationOptions

func (ListSiteOnenoteNotebooksOperationOptions) ToHeaders 

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

func (ListSiteOnenoteNotebooksOperationOptions) ToOData 

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

func (ListSiteOnenoteNotebooksOperationOptions) ToQuery 

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

type ListSiteOnenoteNotebooksOperationResponse 

type ListSiteOnenoteNotebooksOperationResponse 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 SiteOnenoteNotebookClient 

type SiteOnenoteNotebookClient struct {
	Client *msgraph.Client
}

func NewSiteOnenoteNotebookClientWithBaseURI 

func NewSiteOnenoteNotebookClientWithBaseURI(sdkApi sdkEnv.Api) (*SiteOnenoteNotebookClient, error)

func (SiteOnenoteNotebookClient) CopySiteOnenoteNotebookNotebook 

func (c SiteOnenoteNotebookClient) CopySiteOnenoteNotebookNotebook(ctx context.Context, id stable.GroupIdSiteIdOnenoteNotebookId, input CopySiteOnenoteNotebookNotebookRequest, options CopySiteOnenoteNotebookNotebookOperationOptions) (result CopySiteOnenoteNotebookNotebookOperationResponse, err error)

CopySiteOnenoteNotebookNotebook - 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 (SiteOnenoteNotebookClient) CreateSiteOnenoteNotebook 

func (c SiteOnenoteNotebookClient) CreateSiteOnenoteNotebook(ctx context.Context, id stable.GroupIdSiteId, input stable.Notebook, options CreateSiteOnenoteNotebookOperationOptions) (result CreateSiteOnenoteNotebookOperationResponse, err error)

CreateSiteOnenoteNotebook - Create new navigation property to notebooks for groups

func (SiteOnenoteNotebookClient) DeleteSiteOnenoteNotebook 

func (c SiteOnenoteNotebookClient) DeleteSiteOnenoteNotebook(ctx context.Context, id stable.GroupIdSiteIdOnenoteNotebookId, options DeleteSiteOnenoteNotebookOperationOptions) (result DeleteSiteOnenoteNotebookOperationResponse, err error)

DeleteSiteOnenoteNotebook - Delete navigation property notebooks for groups

func (SiteOnenoteNotebookClient) GetSiteOnenoteNotebook 

func (c SiteOnenoteNotebookClient) GetSiteOnenoteNotebook(ctx context.Context, id stable.GroupIdSiteIdOnenoteNotebookId, options GetSiteOnenoteNotebookOperationOptions) (result GetSiteOnenoteNotebookOperationResponse, err error)

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

func (SiteOnenoteNotebookClient) GetSiteOnenoteNotebooksCount 

func (c SiteOnenoteNotebookClient) GetSiteOnenoteNotebooksCount(ctx context.Context, id stable.GroupIdSiteId, options GetSiteOnenoteNotebooksCountOperationOptions) (result GetSiteOnenoteNotebooksCountOperationResponse, err error)

GetSiteOnenoteNotebooksCount - Get the number of the resource

func (SiteOnenoteNotebookClient) GetSiteOnenoteNotebooksFromWebUrl 

func (c SiteOnenoteNotebookClient) GetSiteOnenoteNotebooksFromWebUrl(ctx context.Context, id stable.GroupIdSiteId, input GetSiteOnenoteNotebooksFromWebUrlRequest, options GetSiteOnenoteNotebooksFromWebUrlOperationOptions) (result GetSiteOnenoteNotebooksFromWebUrlOperationResponse, err error)

GetSiteOnenoteNotebooksFromWebUrl - 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 (SiteOnenoteNotebookClient) ListSiteOnenoteNotebooks 

func (c SiteOnenoteNotebookClient) ListSiteOnenoteNotebooks(ctx context.Context, id stable.GroupIdSiteId, options ListSiteOnenoteNotebooksOperationOptions) (result ListSiteOnenoteNotebooksOperationResponse, err error)

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

func (SiteOnenoteNotebookClient) ListSiteOnenoteNotebooksComplete 

func (c SiteOnenoteNotebookClient) ListSiteOnenoteNotebooksComplete(ctx context.Context, id stable.GroupIdSiteId, options ListSiteOnenoteNotebooksOperationOptions) (ListSiteOnenoteNotebooksCompleteResult, error)

ListSiteOnenoteNotebooksComplete retrieves all the results into a single object

func (SiteOnenoteNotebookClient) ListSiteOnenoteNotebooksCompleteMatchingPredicate 

func (c SiteOnenoteNotebookClient) ListSiteOnenoteNotebooksCompleteMatchingPredicate(ctx context.Context, id stable.GroupIdSiteId, options ListSiteOnenoteNotebooksOperationOptions, predicate NotebookOperationPredicate) (result ListSiteOnenoteNotebooksCompleteResult, err error)

ListSiteOnenoteNotebooksCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (SiteOnenoteNotebookClient) UpdateSiteOnenoteNotebook 

func (c SiteOnenoteNotebookClient) UpdateSiteOnenoteNotebook(ctx context.Context, id stable.GroupIdSiteIdOnenoteNotebookId, input stable.Notebook, options UpdateSiteOnenoteNotebookOperationOptions) (result UpdateSiteOnenoteNotebookOperationResponse, err error)

UpdateSiteOnenoteNotebook - Update the navigation property notebooks in groups

type UpdateSiteOnenoteNotebookOperationOptions 

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

func DefaultUpdateSiteOnenoteNotebookOperationOptions 

func DefaultUpdateSiteOnenoteNotebookOperationOptions() UpdateSiteOnenoteNotebookOperationOptions

func (UpdateSiteOnenoteNotebookOperationOptions) ToHeaders 

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

func (UpdateSiteOnenoteNotebookOperationOptions) ToOData 

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

func (UpdateSiteOnenoteNotebookOperationOptions) ToQuery 

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

type UpdateSiteOnenoteNotebookOperationResponse 

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