chatmember

package
v0.20241203.1090052 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/microsoft-graph/users/stable/chatmember Documentation

The chatmember SDK allows for interaction with Microsoft Graph users (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/users/stable/chatmember"

Client Initialization

client := chatmember.NewChatMemberClientWithBaseURI("https://graph.microsoft.com")
client.Client.Authorizer = authorizer

Example Usage: ChatMemberClient.AddChatMembers

ctx := context.TODO()
id := chatmember.NewUserIdChatID("userId", "chatId")

payload := chatmember.AddChatMembersRequest{
	// ...
}


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

Example Usage: ChatMemberClient.CreateChatMember

ctx := context.TODO()
id := chatmember.NewUserIdChatID("userId", "chatId")

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


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

Example Usage: ChatMemberClient.DeleteChatMember

ctx := context.TODO()
id := chatmember.NewUserIdChatIdMemberID("userId", "chatId", "conversationMemberId")

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

Example Usage: ChatMemberClient.GetChatMember

ctx := context.TODO()
id := chatmember.NewUserIdChatIdMemberID("userId", "chatId", "conversationMemberId")

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

Example Usage: ChatMemberClient.GetChatMembersCount

ctx := context.TODO()
id := chatmember.NewUserIdChatID("userId", "chatId")

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

Example Usage: ChatMemberClient.ListChatMembers

ctx := context.TODO()
id := chatmember.NewUserIdChatID("userId", "chatId")

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

Example Usage: ChatMemberClient.UpdateChatMember

ctx := context.TODO()
id := chatmember.NewUserIdChatIdMemberID("userId", "chatId", "conversationMemberId")

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


read, err := client.UpdateChatMember(ctx, id, payload, chatmember.DefaultUpdateChatMemberOperationOptions())
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 AddChatMembersCompleteResult 

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

type AddChatMembersCustomPager 

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

type AddChatMembersOperationOptions 

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

func DefaultAddChatMembersOperationOptions 

func DefaultAddChatMembersOperationOptions() AddChatMembersOperationOptions

func (AddChatMembersOperationOptions) ToHeaders 

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

func (AddChatMembersOperationOptions) ToOData 

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

func (AddChatMembersOperationOptions) ToQuery 

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

type AddChatMembersOperationResponse 

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

type AddChatMembersRequest 

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

type ChatMemberClient 

type ChatMemberClient struct {
	Client *msgraph.Client
}

func NewChatMemberClientWithBaseURI 

func NewChatMemberClientWithBaseURI(sdkApi sdkEnv.Api) (*ChatMemberClient, error)

func (ChatMemberClient) AddChatMembers 

func (c ChatMemberClient) AddChatMembers(ctx context.Context, id stable.UserIdChatId, input AddChatMembersRequest, options AddChatMembersOperationOptions) (result AddChatMembersOperationResponse, err error)

AddChatMembers - 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 (ChatMemberClient) AddChatMembersComplete 

func (c ChatMemberClient) AddChatMembersComplete(ctx context.Context, id stable.UserIdChatId, input AddChatMembersRequest, options AddChatMembersOperationOptions) (AddChatMembersCompleteResult, error)

AddChatMembersComplete retrieves all the results into a single object

func (ChatMemberClient) AddChatMembersCompleteMatchingPredicate 

func (c ChatMemberClient) AddChatMembersCompleteMatchingPredicate(ctx context.Context, id stable.UserIdChatId, input AddChatMembersRequest, options AddChatMembersOperationOptions, predicate ActionResultPartOperationPredicate) (result AddChatMembersCompleteResult, err error)

AddChatMembersCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ChatMemberClient) CreateChatMember 

func (c ChatMemberClient) CreateChatMember(ctx context.Context, id stable.UserIdChatId, input stable.ConversationMember, options CreateChatMemberOperationOptions) (result CreateChatMemberOperationResponse, err error)

CreateChatMember - Create new navigation property to members for users

func (ChatMemberClient) DeleteChatMember 

func (c ChatMemberClient) DeleteChatMember(ctx context.Context, id stable.UserIdChatIdMemberId, options DeleteChatMemberOperationOptions) (result DeleteChatMemberOperationResponse, err error)

DeleteChatMember - Delete navigation property members for users

func (ChatMemberClient) GetChatMember 

func (c ChatMemberClient) GetChatMember(ctx context.Context, id stable.UserIdChatIdMemberId, options GetChatMemberOperationOptions) (result GetChatMemberOperationResponse, err error)

GetChatMember - Get members from users. A collection of all the members in the chat. Nullable.

func (ChatMemberClient) GetChatMembersCount 

func (c ChatMemberClient) GetChatMembersCount(ctx context.Context, id stable.UserIdChatId, options GetChatMembersCountOperationOptions) (result GetChatMembersCountOperationResponse, err error)

GetChatMembersCount - Get the number of the resource

func (ChatMemberClient) ListChatMembers 

func (c ChatMemberClient) ListChatMembers(ctx context.Context, id stable.UserIdChatId, options ListChatMembersOperationOptions) (result ListChatMembersOperationResponse, err error)

ListChatMembers - Get members from users. A collection of all the members in the chat. Nullable.

func (ChatMemberClient) ListChatMembersComplete 

func (c ChatMemberClient) ListChatMembersComplete(ctx context.Context, id stable.UserIdChatId, options ListChatMembersOperationOptions) (ListChatMembersCompleteResult, error)

ListChatMembersComplete retrieves all the results into a single object

func (ChatMemberClient) ListChatMembersCompleteMatchingPredicate 

func (c ChatMemberClient) ListChatMembersCompleteMatchingPredicate(ctx context.Context, id stable.UserIdChatId, options ListChatMembersOperationOptions, predicate ConversationMemberOperationPredicate) (result ListChatMembersCompleteResult, err error)

ListChatMembersCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ChatMemberClient) UpdateChatMember 

func (c ChatMemberClient) UpdateChatMember(ctx context.Context, id stable.UserIdChatIdMemberId, input stable.ConversationMember, options UpdateChatMemberOperationOptions) (result UpdateChatMemberOperationResponse, err error)

UpdateChatMember - Update the navigation property members in users

type ConversationMemberOperationPredicate 

type ConversationMemberOperationPredicate struct {
}

func (ConversationMemberOperationPredicate) Matches 

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

type CreateChatMemberOperationOptions 

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

func DefaultCreateChatMemberOperationOptions 

func DefaultCreateChatMemberOperationOptions() CreateChatMemberOperationOptions

func (CreateChatMemberOperationOptions) ToHeaders 

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

func (CreateChatMemberOperationOptions) ToOData 

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

func (CreateChatMemberOperationOptions) ToQuery 

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

type CreateChatMemberOperationResponse 

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

type DeleteChatMemberOperationOptions 

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

func DefaultDeleteChatMemberOperationOptions 

func DefaultDeleteChatMemberOperationOptions() DeleteChatMemberOperationOptions

func (DeleteChatMemberOperationOptions) ToHeaders 

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

func (DeleteChatMemberOperationOptions) ToOData 

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

func (DeleteChatMemberOperationOptions) ToQuery 

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

type DeleteChatMemberOperationResponse 

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

type GetChatMemberOperationOptions 

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

func DefaultGetChatMemberOperationOptions 

func DefaultGetChatMemberOperationOptions() GetChatMemberOperationOptions

func (GetChatMemberOperationOptions) ToHeaders 

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

func (GetChatMemberOperationOptions) ToOData 

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

func (GetChatMemberOperationOptions) ToQuery 

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

type GetChatMemberOperationResponse 

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

type GetChatMembersCountOperationOptions 

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

func DefaultGetChatMembersCountOperationOptions 

func DefaultGetChatMembersCountOperationOptions() GetChatMembersCountOperationOptions

func (GetChatMembersCountOperationOptions) ToHeaders 

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

func (GetChatMembersCountOperationOptions) ToOData 

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

func (GetChatMembersCountOperationOptions) ToQuery 

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

type GetChatMembersCountOperationResponse 

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

type ListChatMembersCompleteResult 

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

type ListChatMembersCustomPager 

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

type ListChatMembersOperationOptions 

type ListChatMembersOperationOptions 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 DefaultListChatMembersOperationOptions 

func DefaultListChatMembersOperationOptions() ListChatMembersOperationOptions

func (ListChatMembersOperationOptions) ToHeaders 

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

func (ListChatMembersOperationOptions) ToOData 

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

func (ListChatMembersOperationOptions) ToQuery 

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

type ListChatMembersOperationResponse 

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

type UpdateChatMemberOperationOptions 

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

func DefaultUpdateChatMemberOperationOptions 

func DefaultUpdateChatMemberOperationOptions() UpdateChatMemberOperationOptions

func (UpdateChatMemberOperationOptions) ToHeaders 

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

func (UpdateChatMemberOperationOptions) ToOData 

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

func (UpdateChatMemberOperationOptions) ToQuery 

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

type UpdateChatMemberOperationResponse 

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