sitelistpermission

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: 8 Imported by: 0

README

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

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

Client Initialization

client := sitelistpermission.NewSiteListPermissionClientWithBaseURI("https://graph.microsoft.com")
client.Client.Authorizer = authorizer

Example Usage: SiteListPermissionClient.CreateSiteListPermission

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

payload := sitelistpermission.Permission{
	// ...
}


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

Example Usage: SiteListPermissionClient.DeleteSiteListPermission

ctx := context.TODO()
id := sitelistpermission.NewGroupIdSiteIdListIdPermissionID("groupId", "siteId", "listId", "permissionId")

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

Example Usage: SiteListPermissionClient.GetSiteListPermission

ctx := context.TODO()
id := sitelistpermission.NewGroupIdSiteIdListIdPermissionID("groupId", "siteId", "listId", "permissionId")

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

Example Usage: SiteListPermissionClient.GetSiteListPermissionsCount

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

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

Example Usage: SiteListPermissionClient.ListSiteListPermissionGrants

ctx := context.TODO()
id := sitelistpermission.NewGroupIdSiteIdListIdPermissionID("groupId", "siteId", "listId", "permissionId")

payload := sitelistpermission.ListSiteListPermissionGrantsRequest{
	// ...
}


// alternatively `client.ListSiteListPermissionGrants(ctx, id, payload, sitelistpermission.DefaultListSiteListPermissionGrantsOperationOptions())` can be used to do batched pagination
items, err := client.ListSiteListPermissionGrantsComplete(ctx, id, payload, sitelistpermission.DefaultListSiteListPermissionGrantsOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: SiteListPermissionClient.ListSiteListPermissions

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

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

Example Usage: SiteListPermissionClient.RevokeSiteListPermissionGrants

ctx := context.TODO()
id := sitelistpermission.NewGroupIdSiteIdListIdPermissionID("groupId", "siteId", "listId", "permissionId")

payload := sitelistpermission.RevokeSiteListPermissionGrantsRequest{
	// ...
}


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

Example Usage: SiteListPermissionClient.UpdateSiteListPermission

ctx := context.TODO()
id := sitelistpermission.NewGroupIdSiteIdListIdPermissionID("groupId", "siteId", "listId", "permissionId")

payload := sitelistpermission.Permission{
	// ...
}


read, err := client.UpdateSiteListPermission(ctx, id, payload, sitelistpermission.DefaultUpdateSiteListPermissionOperationOptions())
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 CreateSiteListPermissionOperationOptions 

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

func DefaultCreateSiteListPermissionOperationOptions 

func DefaultCreateSiteListPermissionOperationOptions() CreateSiteListPermissionOperationOptions

func (CreateSiteListPermissionOperationOptions) ToHeaders 

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

func (CreateSiteListPermissionOperationOptions) ToOData 

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

func (CreateSiteListPermissionOperationOptions) ToQuery 

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

type CreateSiteListPermissionOperationResponse 

type CreateSiteListPermissionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *beta.Permission
}

type DeleteSiteListPermissionOperationOptions 

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

func DefaultDeleteSiteListPermissionOperationOptions 

func DefaultDeleteSiteListPermissionOperationOptions() DeleteSiteListPermissionOperationOptions

func (DeleteSiteListPermissionOperationOptions) ToHeaders 

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

func (DeleteSiteListPermissionOperationOptions) ToOData 

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

func (DeleteSiteListPermissionOperationOptions) ToQuery 

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

type DeleteSiteListPermissionOperationResponse 

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

type GetSiteListPermissionOperationOptions 

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

func DefaultGetSiteListPermissionOperationOptions 

func DefaultGetSiteListPermissionOperationOptions() GetSiteListPermissionOperationOptions

func (GetSiteListPermissionOperationOptions) ToHeaders 

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

func (GetSiteListPermissionOperationOptions) ToOData 

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

func (GetSiteListPermissionOperationOptions) ToQuery 

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

type GetSiteListPermissionOperationResponse 

type GetSiteListPermissionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *beta.Permission
}

type GetSiteListPermissionsCountOperationOptions 

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

func DefaultGetSiteListPermissionsCountOperationOptions 

func DefaultGetSiteListPermissionsCountOperationOptions() GetSiteListPermissionsCountOperationOptions

func (GetSiteListPermissionsCountOperationOptions) ToHeaders 

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

func (GetSiteListPermissionsCountOperationOptions) ToOData 

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

func (GetSiteListPermissionsCountOperationOptions) ToQuery 

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

type GetSiteListPermissionsCountOperationResponse 

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

type ListSiteListPermissionGrantsCompleteResult 

type ListSiteListPermissionGrantsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []beta.Permission
}

type ListSiteListPermissionGrantsCustomPager 

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

type ListSiteListPermissionGrantsOperationOptions 

type ListSiteListPermissionGrantsOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
	Skip      *int64
	Top       *int64
}

func DefaultListSiteListPermissionGrantsOperationOptions 

func DefaultListSiteListPermissionGrantsOperationOptions() ListSiteListPermissionGrantsOperationOptions

func (ListSiteListPermissionGrantsOperationOptions) ToHeaders 

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

func (ListSiteListPermissionGrantsOperationOptions) ToOData 

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

func (ListSiteListPermissionGrantsOperationOptions) ToQuery 

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

type ListSiteListPermissionGrantsOperationResponse 

type ListSiteListPermissionGrantsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]beta.Permission
}

type ListSiteListPermissionGrantsRequest 

type ListSiteListPermissionGrantsRequest struct {
	Recipients *[]beta.DriveRecipient `json:"recipients,omitempty"`
	Roles      *[]string              `json:"roles,omitempty"`
}

type ListSiteListPermissionsCompleteResult 

type ListSiteListPermissionsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []beta.Permission
}

type ListSiteListPermissionsCustomPager 

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

type ListSiteListPermissionsOperationOptions 

type ListSiteListPermissionsOperationOptions 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 DefaultListSiteListPermissionsOperationOptions 

func DefaultListSiteListPermissionsOperationOptions() ListSiteListPermissionsOperationOptions

func (ListSiteListPermissionsOperationOptions) ToHeaders 

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

func (ListSiteListPermissionsOperationOptions) ToOData 

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

func (ListSiteListPermissionsOperationOptions) ToQuery 

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

type ListSiteListPermissionsOperationResponse 

type ListSiteListPermissionsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]beta.Permission
}

type PermissionOperationPredicate 

type PermissionOperationPredicate struct {
}

func (PermissionOperationPredicate) Matches 

func (p PermissionOperationPredicate) Matches(input beta.Permission) bool

type RevokeSiteListPermissionGrantsOperationOptions 

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

func DefaultRevokeSiteListPermissionGrantsOperationOptions 

func DefaultRevokeSiteListPermissionGrantsOperationOptions() RevokeSiteListPermissionGrantsOperationOptions

func (RevokeSiteListPermissionGrantsOperationOptions) ToHeaders 

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

func (RevokeSiteListPermissionGrantsOperationOptions) ToOData 

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

func (RevokeSiteListPermissionGrantsOperationOptions) ToQuery 

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

type RevokeSiteListPermissionGrantsOperationResponse 

type RevokeSiteListPermissionGrantsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *beta.Permission
}

type RevokeSiteListPermissionGrantsRequest 

type RevokeSiteListPermissionGrantsRequest struct {
	Grantees *[]beta.DriveRecipient `json:"grantees,omitempty"`
}

type SiteListPermissionClient 

type SiteListPermissionClient struct {
	Client *msgraph.Client
}

func NewSiteListPermissionClientWithBaseURI 

func NewSiteListPermissionClientWithBaseURI(sdkApi sdkEnv.Api) (*SiteListPermissionClient, error)

func (SiteListPermissionClient) CreateSiteListPermission 

func (c SiteListPermissionClient) CreateSiteListPermission(ctx context.Context, id beta.GroupIdSiteIdListId, input beta.Permission, options CreateSiteListPermissionOperationOptions) (result CreateSiteListPermissionOperationResponse, err error)

CreateSiteListPermission - Create new navigation property to permissions for groups

func (SiteListPermissionClient) DeleteSiteListPermission 

func (c SiteListPermissionClient) DeleteSiteListPermission(ctx context.Context, id beta.GroupIdSiteIdListIdPermissionId, options DeleteSiteListPermissionOperationOptions) (result DeleteSiteListPermissionOperationResponse, err error)

DeleteSiteListPermission - Delete navigation property permissions for groups

func (SiteListPermissionClient) GetSiteListPermission 

func (c SiteListPermissionClient) GetSiteListPermission(ctx context.Context, id beta.GroupIdSiteIdListIdPermissionId, options GetSiteListPermissionOperationOptions) (result GetSiteListPermissionOperationResponse, err error)

GetSiteListPermission - Get permissions from groups. The set of permissions for the item. Read-only. Nullable.

func (SiteListPermissionClient) GetSiteListPermissionsCount 

func (c SiteListPermissionClient) GetSiteListPermissionsCount(ctx context.Context, id beta.GroupIdSiteIdListId, options GetSiteListPermissionsCountOperationOptions) (result GetSiteListPermissionsCountOperationResponse, err error)

GetSiteListPermissionsCount - Get the number of the resource

func (SiteListPermissionClient) ListSiteListPermissionGrants 

func (c SiteListPermissionClient) ListSiteListPermissionGrants(ctx context.Context, id beta.GroupIdSiteIdListIdPermissionId, input ListSiteListPermissionGrantsRequest, options ListSiteListPermissionGrantsOperationOptions) (result ListSiteListPermissionGrantsOperationResponse, err error)

ListSiteListPermissionGrants - Invoke action grant. Grant users access to a link represented by a permission.

func (SiteListPermissionClient) ListSiteListPermissionGrantsComplete 

func (c SiteListPermissionClient) ListSiteListPermissionGrantsComplete(ctx context.Context, id beta.GroupIdSiteIdListIdPermissionId, input ListSiteListPermissionGrantsRequest, options ListSiteListPermissionGrantsOperationOptions) (ListSiteListPermissionGrantsCompleteResult, error)

ListSiteListPermissionGrantsComplete retrieves all the results into a single object

func (SiteListPermissionClient) ListSiteListPermissionGrantsCompleteMatchingPredicate 

func (c SiteListPermissionClient) ListSiteListPermissionGrantsCompleteMatchingPredicate(ctx context.Context, id beta.GroupIdSiteIdListIdPermissionId, input ListSiteListPermissionGrantsRequest, options ListSiteListPermissionGrantsOperationOptions, predicate PermissionOperationPredicate) (result ListSiteListPermissionGrantsCompleteResult, err error)

ListSiteListPermissionGrantsCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (SiteListPermissionClient) ListSiteListPermissions 

func (c SiteListPermissionClient) ListSiteListPermissions(ctx context.Context, id beta.GroupIdSiteIdListId, options ListSiteListPermissionsOperationOptions) (result ListSiteListPermissionsOperationResponse, err error)

ListSiteListPermissions - Get permissions from groups. The set of permissions for the item. Read-only. Nullable.

func (SiteListPermissionClient) ListSiteListPermissionsComplete 

func (c SiteListPermissionClient) ListSiteListPermissionsComplete(ctx context.Context, id beta.GroupIdSiteIdListId, options ListSiteListPermissionsOperationOptions) (ListSiteListPermissionsCompleteResult, error)

ListSiteListPermissionsComplete retrieves all the results into a single object

func (SiteListPermissionClient) ListSiteListPermissionsCompleteMatchingPredicate 

func (c SiteListPermissionClient) ListSiteListPermissionsCompleteMatchingPredicate(ctx context.Context, id beta.GroupIdSiteIdListId, options ListSiteListPermissionsOperationOptions, predicate PermissionOperationPredicate) (result ListSiteListPermissionsCompleteResult, err error)

ListSiteListPermissionsCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (SiteListPermissionClient) RevokeSiteListPermissionGrants 

func (c SiteListPermissionClient) RevokeSiteListPermissionGrants(ctx context.Context, id beta.GroupIdSiteIdListIdPermissionId, input RevokeSiteListPermissionGrantsRequest, options RevokeSiteListPermissionGrantsOperationOptions) (result RevokeSiteListPermissionGrantsOperationResponse, err error)

RevokeSiteListPermissionGrants - Invoke action revokeGrants. Revoke access to a listItem or driveItem granted via a sharing link by removing the specified recipient from the link.

func (SiteListPermissionClient) UpdateSiteListPermission 

func (c SiteListPermissionClient) UpdateSiteListPermission(ctx context.Context, id beta.GroupIdSiteIdListIdPermissionId, input beta.Permission, options UpdateSiteListPermissionOperationOptions) (result UpdateSiteListPermissionOperationResponse, err error)

UpdateSiteListPermission - Update the navigation property permissions in groups

type UpdateSiteListPermissionOperationOptions 

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

func DefaultUpdateSiteListPermissionOperationOptions 

func DefaultUpdateSiteListPermissionOperationOptions() UpdateSiteListPermissionOperationOptions

func (UpdateSiteListPermissionOperationOptions) ToHeaders 

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

func (UpdateSiteListPermissionOperationOptions) ToOData 

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

func (UpdateSiteListPermissionOperationOptions) ToQuery 

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

type UpdateSiteListPermissionOperationResponse 

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