teamchannel

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/beta/teamchannel Documentation

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

Client Initialization

client := teamchannel.NewTeamChannelClientWithBaseURI("https://graph.microsoft.com")
client.Client.Authorizer = authorizer

Example Usage: TeamChannelClient.CreateTeamChannel

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

payload := teamchannel.Channel{
	// ...
}


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

Example Usage: TeamChannelClient.CreateTeamChannelArchive

ctx := context.TODO()
id := teamchannel.NewGroupIdTeamChannelID("groupId", "channelId")

payload := teamchannel.CreateTeamChannelArchiveRequest{
	// ...
}


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

Example Usage: TeamChannelClient.CreateTeamChannelCompleteMigration

ctx := context.TODO()
id := teamchannel.NewGroupIdTeamChannelID("groupId", "channelId")

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

Example Usage: TeamChannelClient.CreateTeamChannelUnarchive

ctx := context.TODO()
id := teamchannel.NewGroupIdTeamChannelID("groupId", "channelId")

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

Example Usage: TeamChannelClient.DeleteTeamChannel

ctx := context.TODO()
id := teamchannel.NewGroupIdTeamChannelID("groupId", "channelId")

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

Example Usage: TeamChannelClient.GetTeamChannel

ctx := context.TODO()
id := teamchannel.NewGroupIdTeamChannelID("groupId", "channelId")

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

Example Usage: TeamChannelClient.GetTeamChannelsCount

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

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

Example Usage: TeamChannelClient.ListTeamChannels

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

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

Example Usage: TeamChannelClient.ProvisionTeamChannelEmail

ctx := context.TODO()
id := teamchannel.NewGroupIdTeamChannelID("groupId", "channelId")

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

Example Usage: TeamChannelClient.RemoveTeamChannelEmail

ctx := context.TODO()
id := teamchannel.NewGroupIdTeamChannelID("groupId", "channelId")

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

Example Usage: TeamChannelClient.UpdateTeamChannel

ctx := context.TODO()
id := teamchannel.NewGroupIdTeamChannelID("groupId", "channelId")

payload := teamchannel.Channel{
	// ...
}


read, err := client.UpdateTeamChannel(ctx, id, payload, teamchannel.DefaultUpdateTeamChannelOperationOptions())
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 ChannelOperationPredicate 

type ChannelOperationPredicate struct {
}

func (ChannelOperationPredicate) Matches 

func (p ChannelOperationPredicate) Matches(input beta.Channel) bool

type CreateTeamChannelArchiveOperationOptions 

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

func DefaultCreateTeamChannelArchiveOperationOptions 

func DefaultCreateTeamChannelArchiveOperationOptions() CreateTeamChannelArchiveOperationOptions

func (CreateTeamChannelArchiveOperationOptions) ToHeaders 

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

func (CreateTeamChannelArchiveOperationOptions) ToOData 

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

func (CreateTeamChannelArchiveOperationOptions) ToQuery 

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

type CreateTeamChannelArchiveOperationResponse 

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

type CreateTeamChannelArchiveRequest 

type CreateTeamChannelArchiveRequest struct {
	ShouldSetSpoSiteReadOnlyForMembers nullable.Type[bool] `json:"shouldSetSpoSiteReadOnlyForMembers,omitempty"`
}

type CreateTeamChannelCompleteMigrationOperationOptions 

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

func DefaultCreateTeamChannelCompleteMigrationOperationOptions 

func DefaultCreateTeamChannelCompleteMigrationOperationOptions() CreateTeamChannelCompleteMigrationOperationOptions

func (CreateTeamChannelCompleteMigrationOperationOptions) ToHeaders 

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

func (CreateTeamChannelCompleteMigrationOperationOptions) ToOData 

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

func (CreateTeamChannelCompleteMigrationOperationOptions) ToQuery 

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

type CreateTeamChannelCompleteMigrationOperationResponse 

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

type CreateTeamChannelOperationOptions 

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

func DefaultCreateTeamChannelOperationOptions 

func DefaultCreateTeamChannelOperationOptions() CreateTeamChannelOperationOptions

func (CreateTeamChannelOperationOptions) ToHeaders 

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

func (CreateTeamChannelOperationOptions) ToOData 

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

func (CreateTeamChannelOperationOptions) ToQuery 

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

type CreateTeamChannelOperationResponse 

type CreateTeamChannelOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *beta.Channel
}

type CreateTeamChannelUnarchiveOperationOptions 

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

func DefaultCreateTeamChannelUnarchiveOperationOptions 

func DefaultCreateTeamChannelUnarchiveOperationOptions() CreateTeamChannelUnarchiveOperationOptions

func (CreateTeamChannelUnarchiveOperationOptions) ToHeaders 

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

func (CreateTeamChannelUnarchiveOperationOptions) ToOData 

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

func (CreateTeamChannelUnarchiveOperationOptions) ToQuery 

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

type CreateTeamChannelUnarchiveOperationResponse 

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

type DeleteTeamChannelOperationOptions 

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

func DefaultDeleteTeamChannelOperationOptions 

func DefaultDeleteTeamChannelOperationOptions() DeleteTeamChannelOperationOptions

func (DeleteTeamChannelOperationOptions) ToHeaders 

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

func (DeleteTeamChannelOperationOptions) ToOData 

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

func (DeleteTeamChannelOperationOptions) ToQuery 

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

type DeleteTeamChannelOperationResponse 

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

type GetTeamChannelOperationOptions 

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

func DefaultGetTeamChannelOperationOptions 

func DefaultGetTeamChannelOperationOptions() GetTeamChannelOperationOptions

func (GetTeamChannelOperationOptions) ToHeaders 

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

func (GetTeamChannelOperationOptions) ToOData 

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

func (GetTeamChannelOperationOptions) ToQuery 

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

type GetTeamChannelOperationResponse 

type GetTeamChannelOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *beta.Channel
}

type GetTeamChannelsCountOperationOptions 

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

func DefaultGetTeamChannelsCountOperationOptions 

func DefaultGetTeamChannelsCountOperationOptions() GetTeamChannelsCountOperationOptions

func (GetTeamChannelsCountOperationOptions) ToHeaders 

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

func (GetTeamChannelsCountOperationOptions) ToOData 

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

func (GetTeamChannelsCountOperationOptions) ToQuery 

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

type GetTeamChannelsCountOperationResponse 

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

type ListTeamChannelsCompleteResult 

type ListTeamChannelsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []beta.Channel
}

type ListTeamChannelsCustomPager 

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

type ListTeamChannelsOperationOptions 

type ListTeamChannelsOperationOptions 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 DefaultListTeamChannelsOperationOptions 

func DefaultListTeamChannelsOperationOptions() ListTeamChannelsOperationOptions

func (ListTeamChannelsOperationOptions) ToHeaders 

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

func (ListTeamChannelsOperationOptions) ToOData 

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

func (ListTeamChannelsOperationOptions) ToQuery 

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

type ListTeamChannelsOperationResponse 

type ListTeamChannelsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]beta.Channel
}

type ProvisionTeamChannelEmailOperationOptions 

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

func DefaultProvisionTeamChannelEmailOperationOptions 

func DefaultProvisionTeamChannelEmailOperationOptions() ProvisionTeamChannelEmailOperationOptions

func (ProvisionTeamChannelEmailOperationOptions) ToHeaders 

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

func (ProvisionTeamChannelEmailOperationOptions) ToOData 

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

func (ProvisionTeamChannelEmailOperationOptions) ToQuery 

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

type ProvisionTeamChannelEmailOperationResponse 

type ProvisionTeamChannelEmailOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *beta.ProvisionChannelEmailResult
}

type RemoveTeamChannelEmailOperationOptions 

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

func DefaultRemoveTeamChannelEmailOperationOptions 

func DefaultRemoveTeamChannelEmailOperationOptions() RemoveTeamChannelEmailOperationOptions

func (RemoveTeamChannelEmailOperationOptions) ToHeaders 

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

func (RemoveTeamChannelEmailOperationOptions) ToOData 

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

func (RemoveTeamChannelEmailOperationOptions) ToQuery 

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

type RemoveTeamChannelEmailOperationResponse 

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

type TeamChannelClient 

type TeamChannelClient struct {
	Client *msgraph.Client
}

func NewTeamChannelClientWithBaseURI 

func NewTeamChannelClientWithBaseURI(sdkApi sdkEnv.Api) (*TeamChannelClient, error)

func (TeamChannelClient) CreateTeamChannel 

func (c TeamChannelClient) CreateTeamChannel(ctx context.Context, id beta.GroupId, input beta.Channel, options CreateTeamChannelOperationOptions) (result CreateTeamChannelOperationResponse, err error)

CreateTeamChannel - Create new navigation property to channels for groups

func (TeamChannelClient) CreateTeamChannelArchive 

func (c TeamChannelClient) CreateTeamChannelArchive(ctx context.Context, id beta.GroupIdTeamChannelId, input CreateTeamChannelArchiveRequest, options CreateTeamChannelArchiveOperationOptions) (result CreateTeamChannelArchiveOperationResponse, err error)

CreateTeamChannelArchive - Invoke action archive. Archive a channel in a team. When a channel is archived, users can't send new messages or react to existing messages in the channel, edit the channel settings, or make other changes to the channel. You can delete an archived channel or add and remove members from it. If you archive a team, its channels are also archived. Archiving is an asynchronous operation; a channel is archived after the asynchronous archiving operation completes successfully, which might occur after the response returns. A channel without an owner or that belongs to a group that has no owner, can't be archived. To restore a channel from its archived state, use the channel: unarchive method. A channel can’t be archived or unarchived if its team is archived.

func (TeamChannelClient) CreateTeamChannelCompleteMigration 

func (c TeamChannelClient) CreateTeamChannelCompleteMigration(ctx context.Context, id beta.GroupIdTeamChannelId, options CreateTeamChannelCompleteMigrationOperationOptions) (result CreateTeamChannelCompleteMigrationOperationResponse, err error)

CreateTeamChannelCompleteMigration - Invoke action completeMigration. Complete the message migration process by removing migration mode from a channel in a team. Migration mode is a special state that prevents certain operations, like sending messages and adding members, during the data migration process. After a completeMigration request is made, you can't import more messages into the team. You can add members to the team after the request returns a successful response.

func (TeamChannelClient) CreateTeamChannelUnarchive 

func (c TeamChannelClient) CreateTeamChannelUnarchive(ctx context.Context, id beta.GroupIdTeamChannelId, options CreateTeamChannelUnarchiveOperationOptions) (result CreateTeamChannelUnarchiveOperationResponse, err error)

CreateTeamChannelUnarchive - Invoke action unarchive. Restore an archived channel. Unarchiving restores the ability for users to send messages and edit the channel. Channels are archived via the channel: archive method. Unarchiving is an asynchronous operation; a channel is unarchived when the asynchronous unarchiving operation completes successfully, which might occur after this method responds.

func (TeamChannelClient) DeleteTeamChannel 

func (c TeamChannelClient) DeleteTeamChannel(ctx context.Context, id beta.GroupIdTeamChannelId, options DeleteTeamChannelOperationOptions) (result DeleteTeamChannelOperationResponse, err error)

DeleteTeamChannel - Delete navigation property channels for groups

func (TeamChannelClient) GetTeamChannel 

func (c TeamChannelClient) GetTeamChannel(ctx context.Context, id beta.GroupIdTeamChannelId, options GetTeamChannelOperationOptions) (result GetTeamChannelOperationResponse, err error)

GetTeamChannel - Get channels from groups. The collection of channels and messages associated with the team.

func (TeamChannelClient) GetTeamChannelsCount 

func (c TeamChannelClient) GetTeamChannelsCount(ctx context.Context, id beta.GroupId, options GetTeamChannelsCountOperationOptions) (result GetTeamChannelsCountOperationResponse, err error)

GetTeamChannelsCount - Get the number of the resource

func (TeamChannelClient) ListTeamChannels 

func (c TeamChannelClient) ListTeamChannels(ctx context.Context, id beta.GroupId, options ListTeamChannelsOperationOptions) (result ListTeamChannelsOperationResponse, err error)

ListTeamChannels - Get channels from groups. The collection of channels and messages associated with the team.

func (TeamChannelClient) ListTeamChannelsComplete 

func (c TeamChannelClient) ListTeamChannelsComplete(ctx context.Context, id beta.GroupId, options ListTeamChannelsOperationOptions) (ListTeamChannelsCompleteResult, error)

ListTeamChannelsComplete retrieves all the results into a single object

func (TeamChannelClient) ListTeamChannelsCompleteMatchingPredicate 

func (c TeamChannelClient) ListTeamChannelsCompleteMatchingPredicate(ctx context.Context, id beta.GroupId, options ListTeamChannelsOperationOptions, predicate ChannelOperationPredicate) (result ListTeamChannelsCompleteResult, err error)

ListTeamChannelsCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (TeamChannelClient) ProvisionTeamChannelEmail 

func (c TeamChannelClient) ProvisionTeamChannelEmail(ctx context.Context, id beta.GroupIdTeamChannelId, options ProvisionTeamChannelEmailOperationOptions) (result ProvisionTeamChannelEmailOperationResponse, err error)

ProvisionTeamChannelEmail - Invoke action provisionEmail. Provision an email address for a channel. Microsoft Teams doesn't automatically provision an email address for a channel by default. To have Teams provision an email address, you can call provisionEmail, or through the Teams user interface, select Get email address, which triggers Teams to generate an email address if it didn't provisioned one. To remove the email address of a channel, use the removeEmail method.

func (TeamChannelClient) RemoveTeamChannelEmail 

func (c TeamChannelClient) RemoveTeamChannelEmail(ctx context.Context, id beta.GroupIdTeamChannelId, options RemoveTeamChannelEmailOperationOptions) (result RemoveTeamChannelEmailOperationResponse, err error)

RemoveTeamChannelEmail - Invoke action removeEmail. Remove the email address of a channel. You can remove an email address only if it was provisioned using the provisionEmail method or through the Microsoft Teams client.

func (TeamChannelClient) UpdateTeamChannel 

func (c TeamChannelClient) UpdateTeamChannel(ctx context.Context, id beta.GroupIdTeamChannelId, input beta.Channel, options UpdateTeamChannelOperationOptions) (result UpdateTeamChannelOperationResponse, err error)

UpdateTeamChannel - Update the navigation property channels in groups

type UpdateTeamChannelOperationOptions 

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

func DefaultUpdateTeamChannelOperationOptions 

func DefaultUpdateTeamChannelOperationOptions() UpdateTeamChannelOperationOptions

func (UpdateTeamChannelOperationOptions) ToHeaders 

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

func (UpdateTeamChannelOperationOptions) ToOData 

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

func (UpdateTeamChannelOperationOptions) ToQuery 

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

type UpdateTeamChannelOperationResponse 

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