sitelistitem

package
v0.20241128.1084944 Latest Latest
Warning

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

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

README

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

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

Client Initialization

client := sitelistitem.NewSiteListItemClientWithBaseURI("https://graph.microsoft.com")
client.Client.Authorizer = authorizer

Example Usage: SiteListItemClient.CreateSiteListItem

ctx := context.TODO()
id := sitelistitem.NewGroupIdSiteIdListID("groupId", "siteId", "listId")

payload := sitelistitem.ListItem{
	// ...
}


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

ctx := context.TODO()
id := sitelistitem.NewGroupIdSiteIdListIdItemID("groupId", "siteId", "listId", "listItemId")

payload := sitelistitem.CreateSiteListItemLinkRequest{
	// ...
}


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

Example Usage: SiteListItemClient.DeleteSiteListItem

ctx := context.TODO()
id := sitelistitem.NewGroupIdSiteIdListIdItemID("groupId", "siteId", "listId", "listItemId")

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

Example Usage: SiteListItemClient.GetSiteListItem

ctx := context.TODO()
id := sitelistitem.NewGroupIdSiteIdListIdItemID("groupId", "siteId", "listId", "listItemId")

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

Example Usage: SiteListItemClient.ListSiteListItems

ctx := context.TODO()
id := sitelistitem.NewGroupIdSiteIdListID("groupId", "siteId", "listId")

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

Example Usage: SiteListItemClient.UpdateSiteListItem

ctx := context.TODO()
id := sitelistitem.NewGroupIdSiteIdListIdItemID("groupId", "siteId", "listId", "listItemId")

payload := sitelistitem.ListItem{
	// ...
}


read, err := client.UpdateSiteListItem(ctx, id, payload, sitelistitem.DefaultUpdateSiteListItemOperationOptions())
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 CreateSiteListItemLinkOperationOptions 

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

func DefaultCreateSiteListItemLinkOperationOptions 

func DefaultCreateSiteListItemLinkOperationOptions() CreateSiteListItemLinkOperationOptions

func (CreateSiteListItemLinkOperationOptions) ToHeaders 

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

func (CreateSiteListItemLinkOperationOptions) ToOData 

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

func (CreateSiteListItemLinkOperationOptions) ToQuery 

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

type CreateSiteListItemLinkOperationResponse 

type CreateSiteListItemLinkOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *stable.Permission
}

type CreateSiteListItemLinkRequest 

type CreateSiteListItemLinkRequest struct {
	ExpirationDateTime         nullable.Type[string]    `json:"expirationDateTime,omitempty"`
	Message                    nullable.Type[string]    `json:"message,omitempty"`
	Password                   nullable.Type[string]    `json:"password,omitempty"`
	Recipients                 *[]stable.DriveRecipient `json:"recipients,omitempty"`
	RetainInheritedPermissions nullable.Type[bool]      `json:"retainInheritedPermissions,omitempty"`
	Scope                      nullable.Type[string]    `json:"scope,omitempty"`
	SendNotification           nullable.Type[bool]      `json:"sendNotification,omitempty"`
	Type                       nullable.Type[string]    `json:"type,omitempty"`
}

type CreateSiteListItemOperationOptions 

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

func DefaultCreateSiteListItemOperationOptions 

func DefaultCreateSiteListItemOperationOptions() CreateSiteListItemOperationOptions

func (CreateSiteListItemOperationOptions) ToHeaders 

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

func (CreateSiteListItemOperationOptions) ToOData 

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

func (CreateSiteListItemOperationOptions) ToQuery 

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

type CreateSiteListItemOperationResponse 

type CreateSiteListItemOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *stable.ListItem
}

type DeleteSiteListItemOperationOptions 

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

func DefaultDeleteSiteListItemOperationOptions 

func DefaultDeleteSiteListItemOperationOptions() DeleteSiteListItemOperationOptions

func (DeleteSiteListItemOperationOptions) ToHeaders 

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

func (DeleteSiteListItemOperationOptions) ToOData 

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

func (DeleteSiteListItemOperationOptions) ToQuery 

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

type DeleteSiteListItemOperationResponse 

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

type GetSiteListItemOperationOptions 

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

func DefaultGetSiteListItemOperationOptions 

func DefaultGetSiteListItemOperationOptions() GetSiteListItemOperationOptions

func (GetSiteListItemOperationOptions) ToHeaders 

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

func (GetSiteListItemOperationOptions) ToOData 

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

func (GetSiteListItemOperationOptions) ToQuery 

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

type GetSiteListItemOperationResponse 

type GetSiteListItemOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *stable.ListItem
}

type ListItemOperationPredicate 

type ListItemOperationPredicate struct {
}

func (ListItemOperationPredicate) Matches 

func (p ListItemOperationPredicate) Matches(input stable.ListItem) bool

type ListSiteListItemsCompleteResult 

type ListSiteListItemsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []stable.ListItem
}

type ListSiteListItemsCustomPager 

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

type ListSiteListItemsOperationOptions 

type ListSiteListItemsOperationOptions 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 DefaultListSiteListItemsOperationOptions 

func DefaultListSiteListItemsOperationOptions() ListSiteListItemsOperationOptions

func (ListSiteListItemsOperationOptions) ToHeaders 

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

func (ListSiteListItemsOperationOptions) ToOData 

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

func (ListSiteListItemsOperationOptions) ToQuery 

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

type ListSiteListItemsOperationResponse 

type ListSiteListItemsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]stable.ListItem
}

type SiteListItemClient 

type SiteListItemClient struct {
	Client *msgraph.Client
}

func NewSiteListItemClientWithBaseURI 

func NewSiteListItemClientWithBaseURI(sdkApi sdkEnv.Api) (*SiteListItemClient, error)

func (SiteListItemClient) CreateSiteListItem 

func (c SiteListItemClient) CreateSiteListItem(ctx context.Context, id stable.GroupIdSiteIdListId, input stable.ListItem, options CreateSiteListItemOperationOptions) (result CreateSiteListItemOperationResponse, err error)

CreateSiteListItem - Create new navigation property to items for groups 

func (c SiteListItemClient) CreateSiteListItemLink(ctx context.Context, id stable.GroupIdSiteIdListIdItemId, input CreateSiteListItemLinkRequest, options CreateSiteListItemLinkOperationOptions) (result CreateSiteListItemLinkOperationResponse, err error)

CreateSiteListItemLink - Invoke action createLink

func (SiteListItemClient) DeleteSiteListItem 

func (c SiteListItemClient) DeleteSiteListItem(ctx context.Context, id stable.GroupIdSiteIdListIdItemId, options DeleteSiteListItemOperationOptions) (result DeleteSiteListItemOperationResponse, err error)

DeleteSiteListItem - Delete navigation property items for groups

func (SiteListItemClient) GetSiteListItem 

func (c SiteListItemClient) GetSiteListItem(ctx context.Context, id stable.GroupIdSiteIdListIdItemId, options GetSiteListItemOperationOptions) (result GetSiteListItemOperationResponse, err error)

GetSiteListItem - Get items from groups. All items contained in the list.

func (SiteListItemClient) ListSiteListItems 

func (c SiteListItemClient) ListSiteListItems(ctx context.Context, id stable.GroupIdSiteIdListId, options ListSiteListItemsOperationOptions) (result ListSiteListItemsOperationResponse, err error)

ListSiteListItems - Get items from groups. All items contained in the list.

func (SiteListItemClient) ListSiteListItemsComplete 

func (c SiteListItemClient) ListSiteListItemsComplete(ctx context.Context, id stable.GroupIdSiteIdListId, options ListSiteListItemsOperationOptions) (ListSiteListItemsCompleteResult, error)

ListSiteListItemsComplete retrieves all the results into a single object

func (SiteListItemClient) ListSiteListItemsCompleteMatchingPredicate 

func (c SiteListItemClient) ListSiteListItemsCompleteMatchingPredicate(ctx context.Context, id stable.GroupIdSiteIdListId, options ListSiteListItemsOperationOptions, predicate ListItemOperationPredicate) (result ListSiteListItemsCompleteResult, err error)

ListSiteListItemsCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (SiteListItemClient) UpdateSiteListItem 

func (c SiteListItemClient) UpdateSiteListItem(ctx context.Context, id stable.GroupIdSiteIdListIdItemId, input stable.ListItem, options UpdateSiteListItemOperationOptions) (result UpdateSiteListItemOperationResponse, err error)

UpdateSiteListItem - Update the navigation property items in groups

type UpdateSiteListItemOperationOptions 

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

func DefaultUpdateSiteListItemOperationOptions 

func DefaultUpdateSiteListItemOperationOptions() UpdateSiteListItemOperationOptions

func (UpdateSiteListItemOperationOptions) ToHeaders 

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

func (UpdateSiteListItemOperationOptions) ToOData 

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

func (UpdateSiteListItemOperationOptions) ToQuery 

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

type UpdateSiteListItemOperationResponse 

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