joinedteam

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/me/stable/joinedteam Documentation

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

Client Initialization

client := joinedteam.NewJoinedTeamClientWithBaseURI("https://graph.microsoft.com")
client.Client.Authorizer = authorizer

Example Usage: JoinedTeamClient.CreateJoinedTeam

ctx := context.TODO()

payload := joinedteam.Team{
	// ...
}


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

Example Usage: JoinedTeamClient.CreateJoinedTeamArchive

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

payload := joinedteam.CreateJoinedTeamArchiveRequest{
	// ...
}


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

Example Usage: JoinedTeamClient.CreateJoinedTeamClone

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

payload := joinedteam.CreateJoinedTeamCloneRequest{
	// ...
}


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

Example Usage: JoinedTeamClient.CreateJoinedTeamCompleteMigration

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

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

Example Usage: JoinedTeamClient.CreateJoinedTeamUnarchive

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

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

Example Usage: JoinedTeamClient.DeleteJoinedTeam

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

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

Example Usage: JoinedTeamClient.GetJoinedTeam

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

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

Example Usage: JoinedTeamClient.GetJoinedTeamsCount

ctx := context.TODO()


read, err := client.GetJoinedTeamsCount(ctx, joinedteam.DefaultGetJoinedTeamsCountOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: JoinedTeamClient.ListJoinedTeams

ctx := context.TODO()


// alternatively `client.ListJoinedTeams(ctx, joinedteam.DefaultListJoinedTeamsOperationOptions())` can be used to do batched pagination
items, err := client.ListJoinedTeamsComplete(ctx, joinedteam.DefaultListJoinedTeamsOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: JoinedTeamClient.SendJoinedTeamActivityNotification

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

payload := joinedteam.SendJoinedTeamActivityNotificationRequest{
	// ...
}


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

Example Usage: JoinedTeamClient.UpdateJoinedTeam

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

payload := joinedteam.Team{
	// ...
}


read, err := client.UpdateJoinedTeam(ctx, id, payload, joinedteam.DefaultUpdateJoinedTeamOperationOptions())
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 CreateJoinedTeamArchiveOperationOptions

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

func DefaultCreateJoinedTeamArchiveOperationOptions

func DefaultCreateJoinedTeamArchiveOperationOptions() CreateJoinedTeamArchiveOperationOptions

func (CreateJoinedTeamArchiveOperationOptions) ToHeaders

func (CreateJoinedTeamArchiveOperationOptions) ToOData

func (CreateJoinedTeamArchiveOperationOptions) ToQuery

type CreateJoinedTeamArchiveOperationResponse

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

type CreateJoinedTeamArchiveRequest

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

type CreateJoinedTeamCloneOperationOptions

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

func DefaultCreateJoinedTeamCloneOperationOptions

func DefaultCreateJoinedTeamCloneOperationOptions() CreateJoinedTeamCloneOperationOptions

func (CreateJoinedTeamCloneOperationOptions) ToHeaders

func (CreateJoinedTeamCloneOperationOptions) ToOData

func (CreateJoinedTeamCloneOperationOptions) ToQuery

type CreateJoinedTeamCloneOperationResponse

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

type CreateJoinedTeamCloneRequest

type CreateJoinedTeamCloneRequest struct {
	Classification nullable.Type[string]      `json:"classification,omitempty"`
	Description    nullable.Type[string]      `json:"description,omitempty"`
	DisplayName    nullable.Type[string]      `json:"displayName,omitempty"`
	MailNickname   nullable.Type[string]      `json:"mailNickname,omitempty"`
	PartsToClone   *stable.ClonableTeamParts  `json:"partsToClone,omitempty"`
	Visibility     *stable.TeamVisibilityType `json:"visibility,omitempty"`
}

type CreateJoinedTeamCompleteMigrationOperationOptions

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

func DefaultCreateJoinedTeamCompleteMigrationOperationOptions

func DefaultCreateJoinedTeamCompleteMigrationOperationOptions() CreateJoinedTeamCompleteMigrationOperationOptions

func (CreateJoinedTeamCompleteMigrationOperationOptions) ToHeaders

func (CreateJoinedTeamCompleteMigrationOperationOptions) ToOData

func (CreateJoinedTeamCompleteMigrationOperationOptions) ToQuery

type CreateJoinedTeamCompleteMigrationOperationResponse

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

type CreateJoinedTeamOperationOptions

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

func DefaultCreateJoinedTeamOperationOptions

func DefaultCreateJoinedTeamOperationOptions() CreateJoinedTeamOperationOptions

func (CreateJoinedTeamOperationOptions) ToHeaders

func (CreateJoinedTeamOperationOptions) ToOData

func (CreateJoinedTeamOperationOptions) ToQuery

type CreateJoinedTeamOperationResponse

type CreateJoinedTeamOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *stable.Team
}

type CreateJoinedTeamUnarchiveOperationOptions

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

func DefaultCreateJoinedTeamUnarchiveOperationOptions

func DefaultCreateJoinedTeamUnarchiveOperationOptions() CreateJoinedTeamUnarchiveOperationOptions

func (CreateJoinedTeamUnarchiveOperationOptions) ToHeaders

func (CreateJoinedTeamUnarchiveOperationOptions) ToOData

func (CreateJoinedTeamUnarchiveOperationOptions) ToQuery

type CreateJoinedTeamUnarchiveOperationResponse

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

type DeleteJoinedTeamOperationOptions

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

func DefaultDeleteJoinedTeamOperationOptions

func DefaultDeleteJoinedTeamOperationOptions() DeleteJoinedTeamOperationOptions

func (DeleteJoinedTeamOperationOptions) ToHeaders

func (DeleteJoinedTeamOperationOptions) ToOData

func (DeleteJoinedTeamOperationOptions) ToQuery

type DeleteJoinedTeamOperationResponse

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

type GetJoinedTeamOperationOptions

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

func DefaultGetJoinedTeamOperationOptions

func DefaultGetJoinedTeamOperationOptions() GetJoinedTeamOperationOptions

func (GetJoinedTeamOperationOptions) ToHeaders

func (GetJoinedTeamOperationOptions) ToOData

func (GetJoinedTeamOperationOptions) ToQuery

type GetJoinedTeamOperationResponse

type GetJoinedTeamOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *stable.Team
}

type GetJoinedTeamsCountOperationOptions

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

func DefaultGetJoinedTeamsCountOperationOptions

func DefaultGetJoinedTeamsCountOperationOptions() GetJoinedTeamsCountOperationOptions

func (GetJoinedTeamsCountOperationOptions) ToHeaders

func (GetJoinedTeamsCountOperationOptions) ToOData

func (GetJoinedTeamsCountOperationOptions) ToQuery

type GetJoinedTeamsCountOperationResponse

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

type JoinedTeamClient

type JoinedTeamClient struct {
	Client *msgraph.Client
}

func NewJoinedTeamClientWithBaseURI

func NewJoinedTeamClientWithBaseURI(sdkApi sdkEnv.Api) (*JoinedTeamClient, error)

func (JoinedTeamClient) CreateJoinedTeam

CreateJoinedTeam - Create new navigation property to joinedTeams for me

func (JoinedTeamClient) CreateJoinedTeamArchive

CreateJoinedTeamArchive - Invoke action archive. Archive the specified team. When a team is archived, users can no longer make most changes to the team. For example, users can no longer: send or like messages on any channel in the team; edit the team's name or description; nor edit other settings. However, membership changes to the team are still allowed. Archiving is an async operation. A team is archived once the async operation completes successfully, which might occur subsequent to a response from this API. To archive a team, the team and group must have an owner. To restore a team from its archived state, use the API to unarchive.

func (JoinedTeamClient) CreateJoinedTeamClone

CreateJoinedTeamClone - Invoke action clone. Create a copy of a team. This operation also creates a copy of the corresponding group. You can specify which parts of the team to clone: When tabs are cloned, they aren't configured. The tabs are displayed on the tab bar in Microsoft Teams, and the first time a user opens them, they must go through the configuration screen. If the user who opens the tab doesn't have permission to configure apps, they see a message that says that the tab isn't configured. Cloning is a long-running operation. After the POST clone returns, you need to GET the operation returned by the Location: header to see if it's running, succeeded, or failed. You should continue to GET until the status isn't running. The recommended delay between GETs is 5 seconds.

func (JoinedTeamClient) CreateJoinedTeamCompleteMigration

CreateJoinedTeamCompleteMigration - Invoke action completeMigration. Complete the message migration process by removing migration mode from a team. Migration mode is a special state where certain operations are barred, like message POST and membership operations 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 (JoinedTeamClient) CreateJoinedTeamUnarchive

CreateJoinedTeamUnarchive - Invoke action unarchive. Restore an archived team. This API restores users' ability to send messages and edit the team, abiding by tenant and team settings. A Team is archived using the archive API. Unarchiving is an async operation. A team is unarchived once the async operation completes successfully, which might occur subsequent to a response from this API.

func (JoinedTeamClient) DeleteJoinedTeam

DeleteJoinedTeam - Delete navigation property joinedTeams for me

func (JoinedTeamClient) GetJoinedTeam

GetJoinedTeam - Get joinedTeams from me

func (JoinedTeamClient) GetJoinedTeamsCount

GetJoinedTeamsCount - Get the number of the resource

func (JoinedTeamClient) ListJoinedTeams

ListJoinedTeams - List joinedTeams. Get the teams in Microsoft Teams that the user is a direct member of.

func (JoinedTeamClient) ListJoinedTeamsComplete

ListJoinedTeamsComplete retrieves all the results into a single object

func (JoinedTeamClient) ListJoinedTeamsCompleteMatchingPredicate

func (c JoinedTeamClient) ListJoinedTeamsCompleteMatchingPredicate(ctx context.Context, options ListJoinedTeamsOperationOptions, predicate TeamOperationPredicate) (result ListJoinedTeamsCompleteResult, err error)

ListJoinedTeamsCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (JoinedTeamClient) SendJoinedTeamActivityNotification

SendJoinedTeamActivityNotification - Invoke action sendActivityNotification. Send an activity feed notification in the scope of a team. For more information about sending notifications and the requirements for doing so, see sending Teams activity notifications.

func (JoinedTeamClient) UpdateJoinedTeam

UpdateJoinedTeam - Update the navigation property joinedTeams in me

type ListJoinedTeamsCompleteResult

type ListJoinedTeamsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []stable.Team
}

type ListJoinedTeamsCustomPager

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

type ListJoinedTeamsOperationOptions

type ListJoinedTeamsOperationOptions 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 DefaultListJoinedTeamsOperationOptions

func DefaultListJoinedTeamsOperationOptions() ListJoinedTeamsOperationOptions

func (ListJoinedTeamsOperationOptions) ToHeaders

func (ListJoinedTeamsOperationOptions) ToOData

func (ListJoinedTeamsOperationOptions) ToQuery

type ListJoinedTeamsOperationResponse

type ListJoinedTeamsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]stable.Team
}

type SendJoinedTeamActivityNotificationOperationOptions

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

func DefaultSendJoinedTeamActivityNotificationOperationOptions

func DefaultSendJoinedTeamActivityNotificationOperationOptions() SendJoinedTeamActivityNotificationOperationOptions

func (SendJoinedTeamActivityNotificationOperationOptions) ToHeaders

func (SendJoinedTeamActivityNotificationOperationOptions) ToOData

func (SendJoinedTeamActivityNotificationOperationOptions) ToQuery

type SendJoinedTeamActivityNotificationOperationResponse

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

type SendJoinedTeamActivityNotificationRequest

type SendJoinedTeamActivityNotificationRequest struct {
	ActivityType       nullable.Type[string]                 `json:"activityType,omitempty"`
	ChainId            nullable.Type[int64]                  `json:"chainId,omitempty"`
	PreviewText        *stable.ItemBody                      `json:"previewText,omitempty"`
	Recipient          *stable.TeamworkNotificationRecipient `json:"recipient,omitempty"`
	TeamsAppId         nullable.Type[string]                 `json:"teamsAppId,omitempty"`
	TemplateParameters *[]stable.KeyValuePair                `json:"templateParameters,omitempty"`
	Topic              *stable.TeamworkActivityTopic         `json:"topic,omitempty"`
}

type TeamOperationPredicate

type TeamOperationPredicate struct {
}

func (TeamOperationPredicate) Matches

func (p TeamOperationPredicate) Matches(input stable.Team) bool

type UpdateJoinedTeamOperationOptions

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

func DefaultUpdateJoinedTeamOperationOptions

func DefaultUpdateJoinedTeamOperationOptions() UpdateJoinedTeamOperationOptions

func (UpdateJoinedTeamOperationOptions) ToHeaders

func (UpdateJoinedTeamOperationOptions) ToOData

func (UpdateJoinedTeamOperationOptions) ToQuery

type UpdateJoinedTeamOperationResponse

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