followedsite

package
v0.20241021.1074254 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/microsoft-graph/users/stable/followedsite Documentation

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

Client Initialization

client := followedsite.NewFollowedSiteClientWithBaseURI("https://graph.microsoft.com")
client.Client.Authorizer = authorizer

Example Usage: FollowedSiteClient.AddFollowedSites

ctx := context.TODO()
id := followedsite.NewUserID("userId")

payload := followedsite.AddFollowedSitesRequest{
	// ...
}


// alternatively `client.AddFollowedSites(ctx, id, payload, followedsite.DefaultAddFollowedSitesOperationOptions())` can be used to do batched pagination
items, err := client.AddFollowedSitesComplete(ctx, id, payload, followedsite.DefaultAddFollowedSitesOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: FollowedSiteClient.GetFollowedSite

ctx := context.TODO()
id := followedsite.NewUserIdFollowedSiteID("userId", "siteId")

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

Example Usage: FollowedSiteClient.GetFollowedSitesCount

ctx := context.TODO()
id := followedsite.NewUserID("userId")

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

Example Usage: FollowedSiteClient.ListFollowedSites

ctx := context.TODO()
id := followedsite.NewUserID("userId")

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

Example Usage: FollowedSiteClient.RemoveFollowedSites

ctx := context.TODO()
id := followedsite.NewUserID("userId")

payload := followedsite.RemoveFollowedSitesRequest{
	// ...
}


// alternatively `client.RemoveFollowedSites(ctx, id, payload, followedsite.DefaultRemoveFollowedSitesOperationOptions())` can be used to do batched pagination
items, err := client.RemoveFollowedSitesComplete(ctx, id, payload, followedsite.DefaultRemoveFollowedSitesOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AddFollowedSitesCompleteResult 

type AddFollowedSitesCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []stable.Site
}

type AddFollowedSitesCustomPager 

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

type AddFollowedSitesOperationOptions 

type AddFollowedSitesOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
	Skip      *int64
	Top       *int64
}

func DefaultAddFollowedSitesOperationOptions 

func DefaultAddFollowedSitesOperationOptions() AddFollowedSitesOperationOptions

func (AddFollowedSitesOperationOptions) ToHeaders 

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

func (AddFollowedSitesOperationOptions) ToOData 

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

func (AddFollowedSitesOperationOptions) ToQuery 

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

type AddFollowedSitesOperationResponse 

type AddFollowedSitesOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]stable.Site
}

type AddFollowedSitesRequest 

type AddFollowedSitesRequest struct {
	Value *[]stable.Site `json:"value,omitempty"`
}

type FollowedSiteClient 

type FollowedSiteClient struct {
	Client *msgraph.Client
}

func NewFollowedSiteClientWithBaseURI 

func NewFollowedSiteClientWithBaseURI(sdkApi sdkEnv.Api) (*FollowedSiteClient, error)

func (FollowedSiteClient) AddFollowedSites 

func (c FollowedSiteClient) AddFollowedSites(ctx context.Context, id stable.UserId, input AddFollowedSitesRequest, options AddFollowedSitesOperationOptions) (result AddFollowedSitesOperationResponse, err error)

AddFollowedSites - Invoke action add. Follow a user's site or multiple sites.

func (FollowedSiteClient) AddFollowedSitesComplete 

func (c FollowedSiteClient) AddFollowedSitesComplete(ctx context.Context, id stable.UserId, input AddFollowedSitesRequest, options AddFollowedSitesOperationOptions) (AddFollowedSitesCompleteResult, error)

AddFollowedSitesComplete retrieves all the results into a single object

func (FollowedSiteClient) AddFollowedSitesCompleteMatchingPredicate 

func (c FollowedSiteClient) AddFollowedSitesCompleteMatchingPredicate(ctx context.Context, id stable.UserId, input AddFollowedSitesRequest, options AddFollowedSitesOperationOptions, predicate SiteOperationPredicate) (result AddFollowedSitesCompleteResult, err error)

AddFollowedSitesCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (FollowedSiteClient) GetFollowedSite 

func (c FollowedSiteClient) GetFollowedSite(ctx context.Context, id stable.UserIdFollowedSiteId, options GetFollowedSiteOperationOptions) (result GetFollowedSiteOperationResponse, err error)

GetFollowedSite - Get followedSites from users

func (FollowedSiteClient) GetFollowedSitesCount 

func (c FollowedSiteClient) GetFollowedSitesCount(ctx context.Context, id stable.UserId, options GetFollowedSitesCountOperationOptions) (result GetFollowedSitesCountOperationResponse, err error)

GetFollowedSitesCount - Get the number of the resource

func (FollowedSiteClient) ListFollowedSites 

func (c FollowedSiteClient) ListFollowedSites(ctx context.Context, id stable.UserId, options ListFollowedSitesOperationOptions) (result ListFollowedSitesOperationResponse, err error)

ListFollowedSites - Get followedSites from users

func (FollowedSiteClient) ListFollowedSitesComplete 

func (c FollowedSiteClient) ListFollowedSitesComplete(ctx context.Context, id stable.UserId, options ListFollowedSitesOperationOptions) (ListFollowedSitesCompleteResult, error)

ListFollowedSitesComplete retrieves all the results into a single object

func (FollowedSiteClient) ListFollowedSitesCompleteMatchingPredicate 

func (c FollowedSiteClient) ListFollowedSitesCompleteMatchingPredicate(ctx context.Context, id stable.UserId, options ListFollowedSitesOperationOptions, predicate SiteOperationPredicate) (result ListFollowedSitesCompleteResult, err error)

ListFollowedSitesCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (FollowedSiteClient) RemoveFollowedSites 

func (c FollowedSiteClient) RemoveFollowedSites(ctx context.Context, id stable.UserId, input RemoveFollowedSitesRequest, options RemoveFollowedSitesOperationOptions) (result RemoveFollowedSitesOperationResponse, err error)

RemoveFollowedSites - Invoke action remove. Unfollow a user's site or multiple sites.

func (FollowedSiteClient) RemoveFollowedSitesComplete 

func (c FollowedSiteClient) RemoveFollowedSitesComplete(ctx context.Context, id stable.UserId, input RemoveFollowedSitesRequest, options RemoveFollowedSitesOperationOptions) (RemoveFollowedSitesCompleteResult, error)

RemoveFollowedSitesComplete retrieves all the results into a single object

func (FollowedSiteClient) RemoveFollowedSitesCompleteMatchingPredicate 

func (c FollowedSiteClient) RemoveFollowedSitesCompleteMatchingPredicate(ctx context.Context, id stable.UserId, input RemoveFollowedSitesRequest, options RemoveFollowedSitesOperationOptions, predicate SiteOperationPredicate) (result RemoveFollowedSitesCompleteResult, err error)

RemoveFollowedSitesCompleteMatchingPredicate retrieves all the results and then applies the predicate

type GetFollowedSiteOperationOptions 

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

func DefaultGetFollowedSiteOperationOptions 

func DefaultGetFollowedSiteOperationOptions() GetFollowedSiteOperationOptions

func (GetFollowedSiteOperationOptions) ToHeaders 

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

func (GetFollowedSiteOperationOptions) ToOData 

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

func (GetFollowedSiteOperationOptions) ToQuery 

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

type GetFollowedSiteOperationResponse 

type GetFollowedSiteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *stable.Site
}

type GetFollowedSitesCountOperationOptions 

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

func DefaultGetFollowedSitesCountOperationOptions 

func DefaultGetFollowedSitesCountOperationOptions() GetFollowedSitesCountOperationOptions

func (GetFollowedSitesCountOperationOptions) ToHeaders 

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

func (GetFollowedSitesCountOperationOptions) ToOData 

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

func (GetFollowedSitesCountOperationOptions) ToQuery 

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

type GetFollowedSitesCountOperationResponse 

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

type ListFollowedSitesCompleteResult 

type ListFollowedSitesCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []stable.Site
}

type ListFollowedSitesCustomPager 

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

type ListFollowedSitesOperationOptions 

type ListFollowedSitesOperationOptions 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 DefaultListFollowedSitesOperationOptions 

func DefaultListFollowedSitesOperationOptions() ListFollowedSitesOperationOptions

func (ListFollowedSitesOperationOptions) ToHeaders 

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

func (ListFollowedSitesOperationOptions) ToOData 

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

func (ListFollowedSitesOperationOptions) ToQuery 

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

type ListFollowedSitesOperationResponse 

type ListFollowedSitesOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]stable.Site
}

type RemoveFollowedSitesCompleteResult 

type RemoveFollowedSitesCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []stable.Site
}

type RemoveFollowedSitesCustomPager 

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

type RemoveFollowedSitesOperationOptions 

type RemoveFollowedSitesOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
	Skip      *int64
	Top       *int64
}

func DefaultRemoveFollowedSitesOperationOptions 

func DefaultRemoveFollowedSitesOperationOptions() RemoveFollowedSitesOperationOptions

func (RemoveFollowedSitesOperationOptions) ToHeaders 

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

func (RemoveFollowedSitesOperationOptions) ToOData 

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

func (RemoveFollowedSitesOperationOptions) ToQuery 

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

type RemoveFollowedSitesOperationResponse 

type RemoveFollowedSitesOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]stable.Site
}

type RemoveFollowedSitesRequest 

type RemoveFollowedSitesRequest struct {
	Value *[]stable.Site `json:"value,omitempty"`
}

type SiteOperationPredicate 

type SiteOperationPredicate struct {
}

func (SiteOperationPredicate) Matches 

func (p SiteOperationPredicate) Matches(input stable.Site) bool

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.