siteonenotenotebook

package
v0.20241111.1164443 Latest Latest
Warning

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

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

README

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

The siteonenotenotebook SDK allows for interaction with Microsoft Graph groups (API Version beta).

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/beta/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 (CopySiteOnenoteNotebookNotebookOperationOptions) ToOData

func (CopySiteOnenoteNotebookNotebookOperationOptions) ToQuery

type CopySiteOnenoteNotebookNotebookOperationResponse

type CopySiteOnenoteNotebookNotebookOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *beta.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 (CreateSiteOnenoteNotebookOperationOptions) ToOData

func (CreateSiteOnenoteNotebookOperationOptions) ToQuery

type CreateSiteOnenoteNotebookOperationResponse

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

type DeleteSiteOnenoteNotebookOperationOptions

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

func DefaultDeleteSiteOnenoteNotebookOperationOptions

func DefaultDeleteSiteOnenoteNotebookOperationOptions() DeleteSiteOnenoteNotebookOperationOptions

func (DeleteSiteOnenoteNotebookOperationOptions) ToHeaders

func (DeleteSiteOnenoteNotebookOperationOptions) ToOData

func (DeleteSiteOnenoteNotebookOperationOptions) ToQuery

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

func (GetSiteOnenoteNotebookOperationOptions) ToQuery

type GetSiteOnenoteNotebookOperationResponse

type GetSiteOnenoteNotebookOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *beta.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 (GetSiteOnenoteNotebooksCountOperationOptions) ToOData

func (GetSiteOnenoteNotebooksCountOperationOptions) ToQuery

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

func (GetSiteOnenoteNotebooksFromWebUrlOperationOptions) ToQuery

type GetSiteOnenoteNotebooksFromWebUrlOperationResponse

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

type GetSiteOnenoteNotebooksFromWebUrlRequest

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

type ListSiteOnenoteNotebooksCompleteResult

type ListSiteOnenoteNotebooksCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []beta.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 (ListSiteOnenoteNotebooksOperationOptions) ToOData

func (ListSiteOnenoteNotebooksOperationOptions) ToQuery

type ListSiteOnenoteNotebooksOperationResponse

type ListSiteOnenoteNotebooksOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]beta.Notebook
}

type NotebookOperationPredicate

type NotebookOperationPredicate struct {
}

func (NotebookOperationPredicate) Matches

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

type SiteOnenoteNotebookClient

type SiteOnenoteNotebookClient struct {
	Client *msgraph.Client
}

func NewSiteOnenoteNotebookClientWithBaseURI

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

func (SiteOnenoteNotebookClient) CopySiteOnenoteNotebookNotebook

CopySiteOnenoteNotebookNotebook - Invoke action copyNotebook. Copies a notebook to the Notebooks folder in the destination Documents library. The folder is created if it doesn't exist. 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

CreateSiteOnenoteNotebook - Create new navigation property to notebooks for groups

func (SiteOnenoteNotebookClient) DeleteSiteOnenoteNotebook

DeleteSiteOnenoteNotebook - Delete navigation property notebooks for groups

func (SiteOnenoteNotebookClient) GetSiteOnenoteNotebook

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

func (SiteOnenoteNotebookClient) GetSiteOnenoteNotebooksCount

GetSiteOnenoteNotebooksCount - Get the number of the resource

func (SiteOnenoteNotebookClient) GetSiteOnenoteNotebooksFromWebUrl

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

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

func (SiteOnenoteNotebookClient) ListSiteOnenoteNotebooksComplete

ListSiteOnenoteNotebooksComplete retrieves all the results into a single object

func (SiteOnenoteNotebookClient) ListSiteOnenoteNotebooksCompleteMatchingPredicate

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

ListSiteOnenoteNotebooksCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (SiteOnenoteNotebookClient) UpdateSiteOnenoteNotebook

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

func (UpdateSiteOnenoteNotebookOperationOptions) ToQuery

type UpdateSiteOnenoteNotebookOperationResponse

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