joinedteamchannel

package
v0.20241017.1093842 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/microsoft-graph/me/stable/joinedteamchannel Documentation

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

Client Initialization

client := joinedteamchannel.NewJoinedTeamChannelClientWithBaseURI("https://graph.microsoft.com")
client.Client.Authorizer = authorizer

Example Usage: JoinedTeamChannelClient.CreateJoinedTeamChannel

ctx := context.TODO()
id := joinedteamchannel.NewMeJoinedTeamID("teamId")

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


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

Example Usage: JoinedTeamChannelClient.CreateJoinedTeamChannelArchive

ctx := context.TODO()
id := joinedteamchannel.NewMeJoinedTeamIdChannelID("teamId", "channelId")

payload := joinedteamchannel.CreateJoinedTeamChannelArchiveRequest{
	// ...
}


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

Example Usage: JoinedTeamChannelClient.CreateJoinedTeamChannelCompleteMigration

ctx := context.TODO()
id := joinedteamchannel.NewMeJoinedTeamIdChannelID("teamId", "channelId")

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

Example Usage: JoinedTeamChannelClient.CreateJoinedTeamChannelUnarchive

ctx := context.TODO()
id := joinedteamchannel.NewMeJoinedTeamIdChannelID("teamId", "channelId")

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

Example Usage: JoinedTeamChannelClient.DeleteJoinedTeamChannel

ctx := context.TODO()
id := joinedteamchannel.NewMeJoinedTeamIdChannelID("teamId", "channelId")

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

Example Usage: JoinedTeamChannelClient.GetJoinedTeamChannel

ctx := context.TODO()
id := joinedteamchannel.NewMeJoinedTeamIdChannelID("teamId", "channelId")

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

Example Usage: JoinedTeamChannelClient.GetJoinedTeamChannelsCount

ctx := context.TODO()
id := joinedteamchannel.NewMeJoinedTeamID("teamId")

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

Example Usage: JoinedTeamChannelClient.ListJoinedTeamChannels

ctx := context.TODO()
id := joinedteamchannel.NewMeJoinedTeamID("teamId")

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

Example Usage: JoinedTeamChannelClient.ProvisionJoinedTeamChannelEmail

ctx := context.TODO()
id := joinedteamchannel.NewMeJoinedTeamIdChannelID("teamId", "channelId")

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

Example Usage: JoinedTeamChannelClient.RemoveJoinedTeamChannelEmail

ctx := context.TODO()
id := joinedteamchannel.NewMeJoinedTeamIdChannelID("teamId", "channelId")

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

Example Usage: JoinedTeamChannelClient.UpdateJoinedTeamChannel

ctx := context.TODO()
id := joinedteamchannel.NewMeJoinedTeamIdChannelID("teamId", "channelId")

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


read, err := client.UpdateJoinedTeamChannel(ctx, id, payload, joinedteamchannel.DefaultUpdateJoinedTeamChannelOperationOptions())
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 stable.Channel) bool

type CreateJoinedTeamChannelArchiveOperationOptions

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

func DefaultCreateJoinedTeamChannelArchiveOperationOptions

func DefaultCreateJoinedTeamChannelArchiveOperationOptions() CreateJoinedTeamChannelArchiveOperationOptions

func (CreateJoinedTeamChannelArchiveOperationOptions) ToHeaders

func (CreateJoinedTeamChannelArchiveOperationOptions) ToOData

func (CreateJoinedTeamChannelArchiveOperationOptions) ToQuery

type CreateJoinedTeamChannelArchiveOperationResponse

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

type CreateJoinedTeamChannelArchiveRequest

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

type CreateJoinedTeamChannelCompleteMigrationOperationOptions

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

func (CreateJoinedTeamChannelCompleteMigrationOperationOptions) ToHeaders

func (CreateJoinedTeamChannelCompleteMigrationOperationOptions) ToOData

func (CreateJoinedTeamChannelCompleteMigrationOperationOptions) ToQuery

type CreateJoinedTeamChannelCompleteMigrationOperationResponse

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

type CreateJoinedTeamChannelOperationOptions

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

func DefaultCreateJoinedTeamChannelOperationOptions

func DefaultCreateJoinedTeamChannelOperationOptions() CreateJoinedTeamChannelOperationOptions

func (CreateJoinedTeamChannelOperationOptions) ToHeaders

func (CreateJoinedTeamChannelOperationOptions) ToOData

func (CreateJoinedTeamChannelOperationOptions) ToQuery

type CreateJoinedTeamChannelOperationResponse

type CreateJoinedTeamChannelOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *stable.Channel
}

type CreateJoinedTeamChannelUnarchiveOperationOptions

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

func DefaultCreateJoinedTeamChannelUnarchiveOperationOptions

func DefaultCreateJoinedTeamChannelUnarchiveOperationOptions() CreateJoinedTeamChannelUnarchiveOperationOptions

func (CreateJoinedTeamChannelUnarchiveOperationOptions) ToHeaders

func (CreateJoinedTeamChannelUnarchiveOperationOptions) ToOData

func (CreateJoinedTeamChannelUnarchiveOperationOptions) ToQuery

type CreateJoinedTeamChannelUnarchiveOperationResponse

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

type DeleteJoinedTeamChannelOperationOptions

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

func DefaultDeleteJoinedTeamChannelOperationOptions

func DefaultDeleteJoinedTeamChannelOperationOptions() DeleteJoinedTeamChannelOperationOptions

func (DeleteJoinedTeamChannelOperationOptions) ToHeaders

func (DeleteJoinedTeamChannelOperationOptions) ToOData

func (DeleteJoinedTeamChannelOperationOptions) ToQuery

type DeleteJoinedTeamChannelOperationResponse

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

type GetJoinedTeamChannelOperationOptions

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

func DefaultGetJoinedTeamChannelOperationOptions

func DefaultGetJoinedTeamChannelOperationOptions() GetJoinedTeamChannelOperationOptions

func (GetJoinedTeamChannelOperationOptions) ToHeaders

func (GetJoinedTeamChannelOperationOptions) ToOData

func (GetJoinedTeamChannelOperationOptions) ToQuery

type GetJoinedTeamChannelOperationResponse

type GetJoinedTeamChannelOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *stable.Channel
}

type GetJoinedTeamChannelsCountOperationOptions

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

func DefaultGetJoinedTeamChannelsCountOperationOptions

func DefaultGetJoinedTeamChannelsCountOperationOptions() GetJoinedTeamChannelsCountOperationOptions

func (GetJoinedTeamChannelsCountOperationOptions) ToHeaders

func (GetJoinedTeamChannelsCountOperationOptions) ToOData

func (GetJoinedTeamChannelsCountOperationOptions) ToQuery

type GetJoinedTeamChannelsCountOperationResponse

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

type JoinedTeamChannelClient

type JoinedTeamChannelClient struct {
	Client *msgraph.Client
}

func NewJoinedTeamChannelClientWithBaseURI

func NewJoinedTeamChannelClientWithBaseURI(sdkApi sdkEnv.Api) (*JoinedTeamChannelClient, error)

func (JoinedTeamChannelClient) CreateJoinedTeamChannel

CreateJoinedTeamChannel - Create new navigation property to channels for me

func (JoinedTeamChannelClient) CreateJoinedTeamChannelArchive

CreateJoinedTeamChannelArchive - 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 (JoinedTeamChannelClient) CreateJoinedTeamChannelCompleteMigration

CreateJoinedTeamChannelCompleteMigration - 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 additional messages into the team. You can add members to the team after the request returns a successful response.

func (JoinedTeamChannelClient) CreateJoinedTeamChannelUnarchive

CreateJoinedTeamChannelUnarchive - 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 (JoinedTeamChannelClient) DeleteJoinedTeamChannel

DeleteJoinedTeamChannel - Delete navigation property channels for me

func (JoinedTeamChannelClient) GetJoinedTeamChannel

GetJoinedTeamChannel - Get channels from me. The collection of channels and messages associated with the team.

func (JoinedTeamChannelClient) GetJoinedTeamChannelsCount

GetJoinedTeamChannelsCount - Get the number of the resource

func (JoinedTeamChannelClient) ListJoinedTeamChannels

ListJoinedTeamChannels - Get channels from me. The collection of channels and messages associated with the team.

func (JoinedTeamChannelClient) ListJoinedTeamChannelsComplete

ListJoinedTeamChannelsComplete retrieves all the results into a single object

func (JoinedTeamChannelClient) ListJoinedTeamChannelsCompleteMatchingPredicate

func (c JoinedTeamChannelClient) ListJoinedTeamChannelsCompleteMatchingPredicate(ctx context.Context, id stable.MeJoinedTeamId, options ListJoinedTeamChannelsOperationOptions, predicate ChannelOperationPredicate) (result ListJoinedTeamChannelsCompleteResult, err error)

ListJoinedTeamChannelsCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (JoinedTeamChannelClient) ProvisionJoinedTeamChannelEmail

ProvisionJoinedTeamChannelEmail - 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 has not already provisioned one. To remove the email address of a channel, use the removeEmail method.

func (JoinedTeamChannelClient) RemoveJoinedTeamChannelEmail

RemoveJoinedTeamChannelEmail - 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 (JoinedTeamChannelClient) UpdateJoinedTeamChannel

UpdateJoinedTeamChannel - Update the navigation property channels in me

type ListJoinedTeamChannelsCompleteResult

type ListJoinedTeamChannelsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []stable.Channel
}

type ListJoinedTeamChannelsCustomPager

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

type ListJoinedTeamChannelsOperationOptions

type ListJoinedTeamChannelsOperationOptions 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 DefaultListJoinedTeamChannelsOperationOptions

func DefaultListJoinedTeamChannelsOperationOptions() ListJoinedTeamChannelsOperationOptions

func (ListJoinedTeamChannelsOperationOptions) ToHeaders

func (ListJoinedTeamChannelsOperationOptions) ToOData

func (ListJoinedTeamChannelsOperationOptions) ToQuery

type ListJoinedTeamChannelsOperationResponse

type ListJoinedTeamChannelsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]stable.Channel
}

type ProvisionJoinedTeamChannelEmailOperationOptions

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

func DefaultProvisionJoinedTeamChannelEmailOperationOptions

func DefaultProvisionJoinedTeamChannelEmailOperationOptions() ProvisionJoinedTeamChannelEmailOperationOptions

func (ProvisionJoinedTeamChannelEmailOperationOptions) ToHeaders

func (ProvisionJoinedTeamChannelEmailOperationOptions) ToOData

func (ProvisionJoinedTeamChannelEmailOperationOptions) ToQuery

type ProvisionJoinedTeamChannelEmailOperationResponse

type ProvisionJoinedTeamChannelEmailOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *stable.ProvisionChannelEmailResult
}

type RemoveJoinedTeamChannelEmailOperationOptions

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

func DefaultRemoveJoinedTeamChannelEmailOperationOptions

func DefaultRemoveJoinedTeamChannelEmailOperationOptions() RemoveJoinedTeamChannelEmailOperationOptions

func (RemoveJoinedTeamChannelEmailOperationOptions) ToHeaders

func (RemoveJoinedTeamChannelEmailOperationOptions) ToOData

func (RemoveJoinedTeamChannelEmailOperationOptions) ToQuery

type RemoveJoinedTeamChannelEmailOperationResponse

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

type UpdateJoinedTeamChannelOperationOptions

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

func DefaultUpdateJoinedTeamChannelOperationOptions

func DefaultUpdateJoinedTeamChannelOperationOptions() UpdateJoinedTeamChannelOperationOptions

func (UpdateJoinedTeamChannelOperationOptions) ToHeaders

func (UpdateJoinedTeamChannelOperationOptions) ToOData

func (UpdateJoinedTeamChannelOperationOptions) ToQuery

type UpdateJoinedTeamChannelOperationResponse

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL