teamprimarychannel

package
v0.20241206.1180327 Latest Latest
Warning

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

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

README

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

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

Client Initialization

client := teamprimarychannel.NewTeamPrimaryChannelClientWithBaseURI("https://graph.microsoft.com")
client.Client.Authorizer = authorizer

Example Usage: TeamPrimaryChannelClient.CreateTeamPrimaryChannelArchive

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

payload := teamprimarychannel.CreateTeamPrimaryChannelArchiveRequest{
	// ...
}


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

Example Usage: TeamPrimaryChannelClient.CreateTeamPrimaryChannelCompleteMigration

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

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

Example Usage: TeamPrimaryChannelClient.CreateTeamPrimaryChannelUnarchive

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

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

Example Usage: TeamPrimaryChannelClient.DeleteTeamPrimaryChannel

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

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

Example Usage: TeamPrimaryChannelClient.GetTeamPrimaryChannel

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

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

Example Usage: TeamPrimaryChannelClient.ProvisionTeamPrimaryChannelEmail

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

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

Example Usage: TeamPrimaryChannelClient.RemoveTeamPrimaryChannelEmail

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

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

Example Usage: TeamPrimaryChannelClient.UpdateTeamPrimaryChannel

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

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


read, err := client.UpdateTeamPrimaryChannel(ctx, id, payload, teamprimarychannel.DefaultUpdateTeamPrimaryChannelOperationOptions())
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 CreateTeamPrimaryChannelArchiveOperationOptions 

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

func DefaultCreateTeamPrimaryChannelArchiveOperationOptions 

func DefaultCreateTeamPrimaryChannelArchiveOperationOptions() CreateTeamPrimaryChannelArchiveOperationOptions

func (CreateTeamPrimaryChannelArchiveOperationOptions) ToHeaders 

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

func (CreateTeamPrimaryChannelArchiveOperationOptions) ToOData 

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

func (CreateTeamPrimaryChannelArchiveOperationOptions) ToQuery 

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

type CreateTeamPrimaryChannelArchiveOperationResponse 

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

type CreateTeamPrimaryChannelArchiveRequest 

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

type CreateTeamPrimaryChannelCompleteMigrationOperationOptions 

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

func DefaultCreateTeamPrimaryChannelCompleteMigrationOperationOptions 

func DefaultCreateTeamPrimaryChannelCompleteMigrationOperationOptions() CreateTeamPrimaryChannelCompleteMigrationOperationOptions

func (CreateTeamPrimaryChannelCompleteMigrationOperationOptions) ToHeaders 

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

func (CreateTeamPrimaryChannelCompleteMigrationOperationOptions) ToOData 

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

func (CreateTeamPrimaryChannelCompleteMigrationOperationOptions) ToQuery 

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

type CreateTeamPrimaryChannelCompleteMigrationOperationResponse 

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

type CreateTeamPrimaryChannelUnarchiveOperationOptions 

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

func DefaultCreateTeamPrimaryChannelUnarchiveOperationOptions 

func DefaultCreateTeamPrimaryChannelUnarchiveOperationOptions() CreateTeamPrimaryChannelUnarchiveOperationOptions

func (CreateTeamPrimaryChannelUnarchiveOperationOptions) ToHeaders 

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

func (CreateTeamPrimaryChannelUnarchiveOperationOptions) ToOData 

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

func (CreateTeamPrimaryChannelUnarchiveOperationOptions) ToQuery 

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

type CreateTeamPrimaryChannelUnarchiveOperationResponse 

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

type DeleteTeamPrimaryChannelOperationOptions 

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

func DefaultDeleteTeamPrimaryChannelOperationOptions 

func DefaultDeleteTeamPrimaryChannelOperationOptions() DeleteTeamPrimaryChannelOperationOptions

func (DeleteTeamPrimaryChannelOperationOptions) ToHeaders 

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

func (DeleteTeamPrimaryChannelOperationOptions) ToOData 

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

func (DeleteTeamPrimaryChannelOperationOptions) ToQuery 

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

type DeleteTeamPrimaryChannelOperationResponse 

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

type GetTeamPrimaryChannelOperationOptions 

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

func DefaultGetTeamPrimaryChannelOperationOptions 

func DefaultGetTeamPrimaryChannelOperationOptions() GetTeamPrimaryChannelOperationOptions

func (GetTeamPrimaryChannelOperationOptions) ToHeaders 

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

func (GetTeamPrimaryChannelOperationOptions) ToOData 

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

func (GetTeamPrimaryChannelOperationOptions) ToQuery 

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

type GetTeamPrimaryChannelOperationResponse 

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

type ProvisionTeamPrimaryChannelEmailOperationOptions 

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

func DefaultProvisionTeamPrimaryChannelEmailOperationOptions 

func DefaultProvisionTeamPrimaryChannelEmailOperationOptions() ProvisionTeamPrimaryChannelEmailOperationOptions

func (ProvisionTeamPrimaryChannelEmailOperationOptions) ToHeaders 

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

func (ProvisionTeamPrimaryChannelEmailOperationOptions) ToOData 

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

func (ProvisionTeamPrimaryChannelEmailOperationOptions) ToQuery 

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

type ProvisionTeamPrimaryChannelEmailOperationResponse 

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

type RemoveTeamPrimaryChannelEmailOperationOptions 

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

func DefaultRemoveTeamPrimaryChannelEmailOperationOptions 

func DefaultRemoveTeamPrimaryChannelEmailOperationOptions() RemoveTeamPrimaryChannelEmailOperationOptions

func (RemoveTeamPrimaryChannelEmailOperationOptions) ToHeaders 

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

func (RemoveTeamPrimaryChannelEmailOperationOptions) ToOData 

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

func (RemoveTeamPrimaryChannelEmailOperationOptions) ToQuery 

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

type RemoveTeamPrimaryChannelEmailOperationResponse 

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

type TeamPrimaryChannelClient 

type TeamPrimaryChannelClient struct {
	Client *msgraph.Client
}

func NewTeamPrimaryChannelClientWithBaseURI 

func NewTeamPrimaryChannelClientWithBaseURI(sdkApi sdkEnv.Api) (*TeamPrimaryChannelClient, error)

func (TeamPrimaryChannelClient) CreateTeamPrimaryChannelArchive 

func (c TeamPrimaryChannelClient) CreateTeamPrimaryChannelArchive(ctx context.Context, id stable.GroupId, input CreateTeamPrimaryChannelArchiveRequest, options CreateTeamPrimaryChannelArchiveOperationOptions) (result CreateTeamPrimaryChannelArchiveOperationResponse, err error)

CreateTeamPrimaryChannelArchive - 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 (TeamPrimaryChannelClient) CreateTeamPrimaryChannelCompleteMigration 

func (c TeamPrimaryChannelClient) CreateTeamPrimaryChannelCompleteMigration(ctx context.Context, id stable.GroupId, options CreateTeamPrimaryChannelCompleteMigrationOperationOptions) (result CreateTeamPrimaryChannelCompleteMigrationOperationResponse, err error)

CreateTeamPrimaryChannelCompleteMigration - 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 (TeamPrimaryChannelClient) CreateTeamPrimaryChannelUnarchive 

func (c TeamPrimaryChannelClient) CreateTeamPrimaryChannelUnarchive(ctx context.Context, id stable.GroupId, options CreateTeamPrimaryChannelUnarchiveOperationOptions) (result CreateTeamPrimaryChannelUnarchiveOperationResponse, err error)

CreateTeamPrimaryChannelUnarchive - 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 (TeamPrimaryChannelClient) DeleteTeamPrimaryChannel 

func (c TeamPrimaryChannelClient) DeleteTeamPrimaryChannel(ctx context.Context, id stable.GroupId, options DeleteTeamPrimaryChannelOperationOptions) (result DeleteTeamPrimaryChannelOperationResponse, err error)

DeleteTeamPrimaryChannel - Delete navigation property primaryChannel for groups

func (TeamPrimaryChannelClient) GetTeamPrimaryChannel 

func (c TeamPrimaryChannelClient) GetTeamPrimaryChannel(ctx context.Context, id stable.GroupId, options GetTeamPrimaryChannelOperationOptions) (result GetTeamPrimaryChannelOperationResponse, err error)

GetTeamPrimaryChannel - Get primaryChannel from groups. The general channel for the team.

func (TeamPrimaryChannelClient) ProvisionTeamPrimaryChannelEmail 

func (c TeamPrimaryChannelClient) ProvisionTeamPrimaryChannelEmail(ctx context.Context, id stable.GroupId, options ProvisionTeamPrimaryChannelEmailOperationOptions) (result ProvisionTeamPrimaryChannelEmailOperationResponse, err error)

ProvisionTeamPrimaryChannelEmail - 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 (TeamPrimaryChannelClient) RemoveTeamPrimaryChannelEmail 

func (c TeamPrimaryChannelClient) RemoveTeamPrimaryChannelEmail(ctx context.Context, id stable.GroupId, options RemoveTeamPrimaryChannelEmailOperationOptions) (result RemoveTeamPrimaryChannelEmailOperationResponse, err error)

RemoveTeamPrimaryChannelEmail - 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 (TeamPrimaryChannelClient) UpdateTeamPrimaryChannel 

func (c TeamPrimaryChannelClient) UpdateTeamPrimaryChannel(ctx context.Context, id stable.GroupId, input stable.Channel, options UpdateTeamPrimaryChannelOperationOptions) (result UpdateTeamPrimaryChannelOperationResponse, err error)

UpdateTeamPrimaryChannel - Update the navigation property primaryChannel in groups

type UpdateTeamPrimaryChannelOperationOptions 

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

func DefaultUpdateTeamPrimaryChannelOperationOptions 

func DefaultUpdateTeamPrimaryChannelOperationOptions() UpdateTeamPrimaryChannelOperationOptions

func (UpdateTeamPrimaryChannelOperationOptions) ToHeaders 

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

func (UpdateTeamPrimaryChannelOperationOptions) ToOData 

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

func (UpdateTeamPrimaryChannelOperationOptions) ToQuery 

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

type UpdateTeamPrimaryChannelOperationResponse 

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