teammember

package
v0.20241021.1074254 Latest Latest
Warning

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

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

README

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

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

Client Initialization

client := teammember.NewTeamMemberClientWithBaseURI("https://graph.microsoft.com")
client.Client.Authorizer = authorizer

Example Usage: TeamMemberClient.AddTeamMembers

ctx := context.TODO()
id := teammember.NewGroupID("groupId")

payload := teammember.AddTeamMembersRequest{
	// ...
}


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

Example Usage: TeamMemberClient.CreateTeamMember

ctx := context.TODO()
id := teammember.NewGroupID("groupId")

payload := teammember.ConversationMember{
	// ...
}


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

Example Usage: TeamMemberClient.DeleteTeamMember

ctx := context.TODO()
id := teammember.NewGroupIdTeamMemberID("groupId", "conversationMemberId")

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

Example Usage: TeamMemberClient.GetTeamMember

ctx := context.TODO()
id := teammember.NewGroupIdTeamMemberID("groupId", "conversationMemberId")

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

Example Usage: TeamMemberClient.GetTeamMembersCount

ctx := context.TODO()
id := teammember.NewGroupID("groupId")

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

Example Usage: TeamMemberClient.ListTeamMembers

ctx := context.TODO()
id := teammember.NewGroupID("groupId")

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

Example Usage: TeamMemberClient.UpdateTeamMember

ctx := context.TODO()
id := teammember.NewGroupIdTeamMemberID("groupId", "conversationMemberId")

payload := teammember.ConversationMember{
	// ...
}


read, err := client.UpdateTeamMember(ctx, id, payload, teammember.DefaultUpdateTeamMemberOperationOptions())
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 ActionResultPartOperationPredicate 

type ActionResultPartOperationPredicate struct {
}

func (ActionResultPartOperationPredicate) Matches 

func (p ActionResultPartOperationPredicate) Matches(input stable.ActionResultPart) bool

type AddTeamMembersCompleteResult 

type AddTeamMembersCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []stable.ActionResultPart
}

type AddTeamMembersCustomPager 

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

type AddTeamMembersOperationOptions 

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

func DefaultAddTeamMembersOperationOptions 

func DefaultAddTeamMembersOperationOptions() AddTeamMembersOperationOptions

func (AddTeamMembersOperationOptions) ToHeaders 

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

func (AddTeamMembersOperationOptions) ToOData 

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

func (AddTeamMembersOperationOptions) ToQuery 

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

type AddTeamMembersOperationResponse 

type AddTeamMembersOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]stable.ActionResultPart
}

type AddTeamMembersRequest 

type AddTeamMembersRequest struct {
	Values *[]stable.ConversationMember `json:"values,omitempty"`
}

type ConversationMemberOperationPredicate 

type ConversationMemberOperationPredicate struct {
}

func (ConversationMemberOperationPredicate) Matches 

func (p ConversationMemberOperationPredicate) Matches(input stable.ConversationMember) bool

type CreateTeamMemberOperationOptions 

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

func DefaultCreateTeamMemberOperationOptions 

func DefaultCreateTeamMemberOperationOptions() CreateTeamMemberOperationOptions

func (CreateTeamMemberOperationOptions) ToHeaders 

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

func (CreateTeamMemberOperationOptions) ToOData 

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

func (CreateTeamMemberOperationOptions) ToQuery 

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

type CreateTeamMemberOperationResponse 

type CreateTeamMemberOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        stable.ConversationMember
}

type DeleteTeamMemberOperationOptions 

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

func DefaultDeleteTeamMemberOperationOptions 

func DefaultDeleteTeamMemberOperationOptions() DeleteTeamMemberOperationOptions

func (DeleteTeamMemberOperationOptions) ToHeaders 

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

func (DeleteTeamMemberOperationOptions) ToOData 

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

func (DeleteTeamMemberOperationOptions) ToQuery 

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

type DeleteTeamMemberOperationResponse 

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

type GetTeamMemberOperationOptions 

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

func DefaultGetTeamMemberOperationOptions 

func DefaultGetTeamMemberOperationOptions() GetTeamMemberOperationOptions

func (GetTeamMemberOperationOptions) ToHeaders 

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

func (GetTeamMemberOperationOptions) ToOData 

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

func (GetTeamMemberOperationOptions) ToQuery 

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

type GetTeamMemberOperationResponse 

type GetTeamMemberOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        stable.ConversationMember
}

type GetTeamMembersCountOperationOptions 

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

func DefaultGetTeamMembersCountOperationOptions 

func DefaultGetTeamMembersCountOperationOptions() GetTeamMembersCountOperationOptions

func (GetTeamMembersCountOperationOptions) ToHeaders 

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

func (GetTeamMembersCountOperationOptions) ToOData 

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

func (GetTeamMembersCountOperationOptions) ToQuery 

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

type GetTeamMembersCountOperationResponse 

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

type ListTeamMembersCompleteResult 

type ListTeamMembersCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []stable.ConversationMember
}

type ListTeamMembersCustomPager 

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

type ListTeamMembersOperationOptions 

type ListTeamMembersOperationOptions 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 DefaultListTeamMembersOperationOptions 

func DefaultListTeamMembersOperationOptions() ListTeamMembersOperationOptions

func (ListTeamMembersOperationOptions) ToHeaders 

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

func (ListTeamMembersOperationOptions) ToOData 

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

func (ListTeamMembersOperationOptions) ToQuery 

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

type ListTeamMembersOperationResponse 

type ListTeamMembersOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]stable.ConversationMember
}

type TeamMemberClient 

type TeamMemberClient struct {
	Client *msgraph.Client
}

func NewTeamMemberClientWithBaseURI 

func NewTeamMemberClientWithBaseURI(sdkApi sdkEnv.Api) (*TeamMemberClient, error)

func (TeamMemberClient) AddTeamMembers 

func (c TeamMemberClient) AddTeamMembers(ctx context.Context, id stable.GroupId, input AddTeamMembersRequest, options AddTeamMembersOperationOptions) (result AddTeamMembersOperationResponse, err error)

AddTeamMembers - Invoke action add. Add multiple members in a single request to a team. The response provides details about which memberships could and couldn't be created.

func (TeamMemberClient) AddTeamMembersComplete 

func (c TeamMemberClient) AddTeamMembersComplete(ctx context.Context, id stable.GroupId, input AddTeamMembersRequest, options AddTeamMembersOperationOptions) (AddTeamMembersCompleteResult, error)

AddTeamMembersComplete retrieves all the results into a single object

func (TeamMemberClient) AddTeamMembersCompleteMatchingPredicate 

func (c TeamMemberClient) AddTeamMembersCompleteMatchingPredicate(ctx context.Context, id stable.GroupId, input AddTeamMembersRequest, options AddTeamMembersOperationOptions, predicate ActionResultPartOperationPredicate) (result AddTeamMembersCompleteResult, err error)

AddTeamMembersCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (TeamMemberClient) CreateTeamMember 

func (c TeamMemberClient) CreateTeamMember(ctx context.Context, id stable.GroupId, input stable.ConversationMember, options CreateTeamMemberOperationOptions) (result CreateTeamMemberOperationResponse, err error)

CreateTeamMember - Create new navigation property to members for groups

func (TeamMemberClient) DeleteTeamMember 

func (c TeamMemberClient) DeleteTeamMember(ctx context.Context, id stable.GroupIdTeamMemberId, options DeleteTeamMemberOperationOptions) (result DeleteTeamMemberOperationResponse, err error)

DeleteTeamMember - Delete navigation property members for groups

func (TeamMemberClient) GetTeamMember 

func (c TeamMemberClient) GetTeamMember(ctx context.Context, id stable.GroupIdTeamMemberId, options GetTeamMemberOperationOptions) (result GetTeamMemberOperationResponse, err error)

GetTeamMember - Get members from groups. Members and owners of the team.

func (TeamMemberClient) GetTeamMembersCount 

func (c TeamMemberClient) GetTeamMembersCount(ctx context.Context, id stable.GroupId, options GetTeamMembersCountOperationOptions) (result GetTeamMembersCountOperationResponse, err error)

GetTeamMembersCount - Get the number of the resource

func (TeamMemberClient) ListTeamMembers 

func (c TeamMemberClient) ListTeamMembers(ctx context.Context, id stable.GroupId, options ListTeamMembersOperationOptions) (result ListTeamMembersOperationResponse, err error)

ListTeamMembers - Get members from groups. Members and owners of the team.

func (TeamMemberClient) ListTeamMembersComplete 

func (c TeamMemberClient) ListTeamMembersComplete(ctx context.Context, id stable.GroupId, options ListTeamMembersOperationOptions) (ListTeamMembersCompleteResult, error)

ListTeamMembersComplete retrieves all the results into a single object

func (TeamMemberClient) ListTeamMembersCompleteMatchingPredicate 

func (c TeamMemberClient) ListTeamMembersCompleteMatchingPredicate(ctx context.Context, id stable.GroupId, options ListTeamMembersOperationOptions, predicate ConversationMemberOperationPredicate) (result ListTeamMembersCompleteResult, err error)

ListTeamMembersCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (TeamMemberClient) UpdateTeamMember 

func (c TeamMemberClient) UpdateTeamMember(ctx context.Context, id stable.GroupIdTeamMemberId, input stable.ConversationMember, options UpdateTeamMemberOperationOptions) (result UpdateTeamMemberOperationResponse, err error)

UpdateTeamMember - Update the navigation property members in groups

type UpdateTeamMemberOperationOptions 

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

func DefaultUpdateTeamMemberOperationOptions 

func DefaultUpdateTeamMemberOperationOptions() UpdateTeamMemberOperationOptions

func (UpdateTeamMemberOperationOptions) ToHeaders 

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

func (UpdateTeamMemberOperationOptions) ToOData 

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

func (UpdateTeamMemberOperationOptions) ToQuery 

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

type UpdateTeamMemberOperationResponse 

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