followedsite

package
v0.20241023.1122425 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/microsoft-graph/me/beta/followedsite Documentation

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

Client Initialization

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

Example Usage: FollowedSiteClient.AddFollowedSites

ctx := context.TODO()

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


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

Example Usage: FollowedSiteClient.GetFollowedSite

ctx := context.TODO()
id := followedsite.NewMeFollowedSiteID("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()


read, err := client.GetFollowedSitesCount(ctx, 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()


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

Example Usage: FollowedSiteClient.RemoveFollowedSites

ctx := context.TODO()

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


// alternatively `client.RemoveFollowedSites(ctx, payload, followedsite.DefaultRemoveFollowedSitesOperationOptions())` can be used to do batched pagination
items, err := client.RemoveFollowedSitesComplete(ctx, 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              []beta.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 (AddFollowedSitesOperationOptions) ToOData

func (AddFollowedSitesOperationOptions) ToQuery

type AddFollowedSitesOperationResponse

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

type AddFollowedSitesRequest

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

type FollowedSiteClient

type FollowedSiteClient struct {
	Client *msgraph.Client
}

func NewFollowedSiteClientWithBaseURI

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

func (FollowedSiteClient) AddFollowedSites

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

func (FollowedSiteClient) AddFollowedSitesComplete

AddFollowedSitesComplete retrieves all the results into a single object

func (FollowedSiteClient) AddFollowedSitesCompleteMatchingPredicate

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

AddFollowedSitesCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (FollowedSiteClient) GetFollowedSite

GetFollowedSite - Get followedSites from me

func (FollowedSiteClient) GetFollowedSitesCount

GetFollowedSitesCount - Get the number of the resource

func (FollowedSiteClient) ListFollowedSites

ListFollowedSites - List followed sites. List the sites that have been followed by the signed in user.

func (FollowedSiteClient) ListFollowedSitesComplete

ListFollowedSitesComplete retrieves all the results into a single object

func (FollowedSiteClient) ListFollowedSitesCompleteMatchingPredicate

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

ListFollowedSitesCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (FollowedSiteClient) RemoveFollowedSites

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

func (FollowedSiteClient) RemoveFollowedSitesComplete

RemoveFollowedSitesComplete retrieves all the results into a single object

func (FollowedSiteClient) RemoveFollowedSitesCompleteMatchingPredicate

func (c FollowedSiteClient) RemoveFollowedSitesCompleteMatchingPredicate(ctx context.Context, 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 (GetFollowedSiteOperationOptions) ToOData

func (GetFollowedSiteOperationOptions) ToQuery

type GetFollowedSiteOperationResponse

type GetFollowedSiteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *beta.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 (GetFollowedSitesCountOperationOptions) ToOData

func (GetFollowedSitesCountOperationOptions) ToQuery

type GetFollowedSitesCountOperationResponse

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

type ListFollowedSitesCompleteResult

type ListFollowedSitesCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []beta.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 (ListFollowedSitesOperationOptions) ToOData

func (ListFollowedSitesOperationOptions) ToQuery

type ListFollowedSitesOperationResponse

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

type RemoveFollowedSitesCompleteResult

type RemoveFollowedSitesCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []beta.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 (RemoveFollowedSitesOperationOptions) ToOData

func (RemoveFollowedSitesOperationOptions) ToQuery

type RemoveFollowedSitesOperationResponse

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

type RemoveFollowedSitesRequest

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

type SiteOperationPredicate

type SiteOperationPredicate struct {
}

func (SiteOperationPredicate) Matches

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

Jump to

Keyboard shortcuts

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