teamprimarychannel

package
v0.20241205.1102105 Latest Latest
Warning

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

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

README

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

The teamprimarychannel 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/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 (CreateTeamPrimaryChannelArchiveOperationOptions) ToOData

func (CreateTeamPrimaryChannelArchiveOperationOptions) ToQuery

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 (CreateTeamPrimaryChannelCompleteMigrationOperationOptions) ToHeaders

func (CreateTeamPrimaryChannelCompleteMigrationOperationOptions) ToOData

func (CreateTeamPrimaryChannelCompleteMigrationOperationOptions) ToQuery

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 (CreateTeamPrimaryChannelUnarchiveOperationOptions) ToOData

func (CreateTeamPrimaryChannelUnarchiveOperationOptions) ToQuery

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 (DeleteTeamPrimaryChannelOperationOptions) ToOData

func (DeleteTeamPrimaryChannelOperationOptions) ToQuery

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 (GetTeamPrimaryChannelOperationOptions) ToOData

func (GetTeamPrimaryChannelOperationOptions) ToQuery

type GetTeamPrimaryChannelOperationResponse

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

type ProvisionTeamPrimaryChannelEmailOperationOptions

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

func DefaultProvisionTeamPrimaryChannelEmailOperationOptions

func DefaultProvisionTeamPrimaryChannelEmailOperationOptions() ProvisionTeamPrimaryChannelEmailOperationOptions

func (ProvisionTeamPrimaryChannelEmailOperationOptions) ToHeaders

func (ProvisionTeamPrimaryChannelEmailOperationOptions) ToOData

func (ProvisionTeamPrimaryChannelEmailOperationOptions) ToQuery

type ProvisionTeamPrimaryChannelEmailOperationResponse

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

type RemoveTeamPrimaryChannelEmailOperationOptions

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

func DefaultRemoveTeamPrimaryChannelEmailOperationOptions

func DefaultRemoveTeamPrimaryChannelEmailOperationOptions() RemoveTeamPrimaryChannelEmailOperationOptions

func (RemoveTeamPrimaryChannelEmailOperationOptions) ToHeaders

func (RemoveTeamPrimaryChannelEmailOperationOptions) ToOData

func (RemoveTeamPrimaryChannelEmailOperationOptions) ToQuery

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

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

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

func (TeamPrimaryChannelClient) CreateTeamPrimaryChannelUnarchive

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

DeleteTeamPrimaryChannel - Delete navigation property primaryChannel for groups

func (TeamPrimaryChannelClient) GetTeamPrimaryChannel

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

func (TeamPrimaryChannelClient) ProvisionTeamPrimaryChannelEmail

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 didn't provisioned one. To remove the email address of a channel, use the removeEmail method.

func (TeamPrimaryChannelClient) RemoveTeamPrimaryChannelEmail

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

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 (UpdateTeamPrimaryChannelOperationOptions) ToOData

func (UpdateTeamPrimaryChannelOperationOptions) ToQuery

type UpdateTeamPrimaryChannelOperationResponse

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