README ¶
github.com/hashicorp/go-azure-sdk/microsoft-graph/me/beta/onenotenotebook
Documentation
The onenotenotebook
SDK allows for interaction with Microsoft Graph me
(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/me/beta/onenotenotebook"
Client Initialization
client := onenotenotebook.NewOnenoteNotebookClientWithBaseURI("https://graph.microsoft.com")
client.Client.Authorizer = authorizer
Example Usage: OnenoteNotebookClient.CopyOnenoteNotebookNotebook
ctx := context.TODO()
id := onenotenotebook.NewMeOnenoteNotebookID("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()
payload := onenotenotebook.Notebook{
// ...
}
read, err := client.CreateOnenoteNotebook(ctx, 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.NewMeOnenoteNotebookID("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.NewMeOnenoteNotebookID("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()
read, err := client.GetOnenoteNotebooksCount(ctx, 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()
payload := onenotenotebook.GetOnenoteNotebooksFromWebUrlRequest{
// ...
}
read, err := client.GetOnenoteNotebooksFromWebUrl(ctx, 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()
// alternatively `client.ListOnenoteNotebooks(ctx, onenotenotebook.DefaultListOnenoteNotebooksOperationOptions())` can be used to do batched pagination
items, err := client.ListOnenoteNotebooksComplete(ctx, onenotenotebook.DefaultListOnenoteNotebooksOperationOptions())
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: OnenoteNotebookClient.UpdateOnenoteNotebook
ctx := context.TODO()
id := onenotenotebook.NewMeOnenoteNotebookID("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 ¶
- type CopyOnenoteNotebookNotebookOperationOptions
- type CopyOnenoteNotebookNotebookOperationResponse
- type CopyOnenoteNotebookNotebookRequest
- type CreateOnenoteNotebookOperationOptions
- type CreateOnenoteNotebookOperationResponse
- type DeleteOnenoteNotebookOperationOptions
- type DeleteOnenoteNotebookOperationResponse
- type GetOnenoteNotebookOperationOptions
- type GetOnenoteNotebookOperationResponse
- type GetOnenoteNotebooksCountOperationOptions
- type GetOnenoteNotebooksCountOperationResponse
- type GetOnenoteNotebooksFromWebUrlOperationOptions
- type GetOnenoteNotebooksFromWebUrlOperationResponse
- type GetOnenoteNotebooksFromWebUrlRequest
- type ListOnenoteNotebooksCompleteResult
- type ListOnenoteNotebooksCustomPager
- type ListOnenoteNotebooksOperationOptions
- type ListOnenoteNotebooksOperationResponse
- type NotebookOperationPredicate
- type OnenoteNotebookClient
- func (c OnenoteNotebookClient) CopyOnenoteNotebookNotebook(ctx context.Context, id beta.MeOnenoteNotebookId, ...) (result CopyOnenoteNotebookNotebookOperationResponse, err error)
- func (c OnenoteNotebookClient) CreateOnenoteNotebook(ctx context.Context, input beta.Notebook, ...) (result CreateOnenoteNotebookOperationResponse, err error)
- func (c OnenoteNotebookClient) DeleteOnenoteNotebook(ctx context.Context, id beta.MeOnenoteNotebookId, ...) (result DeleteOnenoteNotebookOperationResponse, err error)
- func (c OnenoteNotebookClient) GetOnenoteNotebook(ctx context.Context, id beta.MeOnenoteNotebookId, ...) (result GetOnenoteNotebookOperationResponse, err error)
- func (c OnenoteNotebookClient) GetOnenoteNotebooksCount(ctx context.Context, options GetOnenoteNotebooksCountOperationOptions) (result GetOnenoteNotebooksCountOperationResponse, err error)
- func (c OnenoteNotebookClient) GetOnenoteNotebooksFromWebUrl(ctx context.Context, input GetOnenoteNotebooksFromWebUrlRequest, ...) (result GetOnenoteNotebooksFromWebUrlOperationResponse, err error)
- func (c OnenoteNotebookClient) ListOnenoteNotebooks(ctx context.Context, options ListOnenoteNotebooksOperationOptions) (result ListOnenoteNotebooksOperationResponse, err error)
- func (c OnenoteNotebookClient) ListOnenoteNotebooksComplete(ctx context.Context, options ListOnenoteNotebooksOperationOptions) (ListOnenoteNotebooksCompleteResult, error)
- func (c OnenoteNotebookClient) ListOnenoteNotebooksCompleteMatchingPredicate(ctx context.Context, options ListOnenoteNotebooksOperationOptions, ...) (result ListOnenoteNotebooksCompleteResult, err error)
- func (c OnenoteNotebookClient) UpdateOnenoteNotebook(ctx context.Context, id beta.MeOnenoteNotebookId, input beta.Notebook, ...) (result UpdateOnenoteNotebookOperationResponse, err error)
- type UpdateOnenoteNotebookOperationOptions
- type UpdateOnenoteNotebookOperationResponse
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 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 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 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 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 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 ListOnenoteNotebooksCustomPager ¶
func (*ListOnenoteNotebooksCustomPager) NextPageLink ¶
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 NotebookOperationPredicate ¶
type NotebookOperationPredicate struct { }
type OnenoteNotebookClient ¶
func NewOnenoteNotebookClientWithBaseURI ¶
func NewOnenoteNotebookClientWithBaseURI(sdkApi sdkEnv.Api) (*OnenoteNotebookClient, error)
func (OnenoteNotebookClient) CopyOnenoteNotebookNotebook ¶
func (c OnenoteNotebookClient) CopyOnenoteNotebookNotebook(ctx context.Context, id beta.MeOnenoteNotebookId, input CopyOnenoteNotebookNotebookRequest, options CopyOnenoteNotebookNotebookOperationOptions) (result CopyOnenoteNotebookNotebookOperationResponse, err error)
CopyOnenoteNotebookNotebook - 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 (OnenoteNotebookClient) CreateOnenoteNotebook ¶
func (c OnenoteNotebookClient) CreateOnenoteNotebook(ctx context.Context, input beta.Notebook, options CreateOnenoteNotebookOperationOptions) (result CreateOnenoteNotebookOperationResponse, err error)
CreateOnenoteNotebook - Create notebook. Create a new OneNote notebook.
func (OnenoteNotebookClient) DeleteOnenoteNotebook ¶
func (c OnenoteNotebookClient) DeleteOnenoteNotebook(ctx context.Context, id beta.MeOnenoteNotebookId, options DeleteOnenoteNotebookOperationOptions) (result DeleteOnenoteNotebookOperationResponse, err error)
DeleteOnenoteNotebook - Delete navigation property notebooks for me
func (OnenoteNotebookClient) GetOnenoteNotebook ¶
func (c OnenoteNotebookClient) GetOnenoteNotebook(ctx context.Context, id beta.MeOnenoteNotebookId, options GetOnenoteNotebookOperationOptions) (result GetOnenoteNotebookOperationResponse, err error)
GetOnenoteNotebook - Get notebook. Retrieve the properties and relationships of a notebook object.
func (OnenoteNotebookClient) GetOnenoteNotebooksCount ¶
func (c OnenoteNotebookClient) GetOnenoteNotebooksCount(ctx context.Context, options GetOnenoteNotebooksCountOperationOptions) (result GetOnenoteNotebooksCountOperationResponse, err error)
GetOnenoteNotebooksCount - Get the number of the resource
func (OnenoteNotebookClient) GetOnenoteNotebooksFromWebUrl ¶
func (c OnenoteNotebookClient) GetOnenoteNotebooksFromWebUrl(ctx context.Context, 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, options ListOnenoteNotebooksOperationOptions) (result ListOnenoteNotebooksOperationResponse, err error)
ListOnenoteNotebooks - List notebooks. Retrieve a list of notebook objects.
func (OnenoteNotebookClient) ListOnenoteNotebooksComplete ¶
func (c OnenoteNotebookClient) ListOnenoteNotebooksComplete(ctx context.Context, options ListOnenoteNotebooksOperationOptions) (ListOnenoteNotebooksCompleteResult, error)
ListOnenoteNotebooksComplete retrieves all the results into a single object
func (OnenoteNotebookClient) ListOnenoteNotebooksCompleteMatchingPredicate ¶
func (c OnenoteNotebookClient) ListOnenoteNotebooksCompleteMatchingPredicate(ctx context.Context, 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 beta.MeOnenoteNotebookId, input beta.Notebook, options UpdateOnenoteNotebookOperationOptions) (result UpdateOnenoteNotebookOperationResponse, err error)
UpdateOnenoteNotebook - Update the navigation property notebooks in me
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
Source Files ¶
- client.go
- method_copyonenotenotebooknotebook.go
- method_createonenotenotebook.go
- method_deleteonenotenotebook.go
- method_getonenotenotebook.go
- method_getonenotenotebookscount.go
- method_getonenotenotebooksfromweburl.go
- method_listonenotenotebooks.go
- method_updateonenotenotebook.go
- model_copyonenotenotebooknotebookrequest.go
- model_getonenotenotebooksfromweburlrequest.go
- predicates.go
- version.go