commercetools.Sdk.Api.Client.RequestBuilders.Messages.ByProjectKeyMessagesGet Class Reference

Inherits commercetools.Sdk.Api.Client.IPagedQueryResourceRequest< ByProjectKeyMessagesGet, IMessagePagedQueryResponse, MessageQueryBuilderDsl >, commercetools.Sdk.Api.Models.IPagedQueryResourceRequest< ByProjectKeyMessagesGet, commercetools.Sdk.Api.Models.Messages.IMessagePagedQueryResponse >, commercetools.Base.Client.ApiMethod< ByProjectKeyMessagesGet >, commercetools.Base.Client.IApiMethod< ByProjectKeyMessagesGet, commercetools.Sdk.Api.Models.Messages.IMessagePagedQueryResponse >, commercetools.Sdk.Api.Client.IExpandableTrait< ByProjectKeyMessagesGet >, commercetools.Sdk.Api.Client.ISortableTrait< ByProjectKeyMessagesGet >, commercetools.Sdk.Api.Client.IPagingTrait< ByProjectKeyMessagesGet >, commercetools.Sdk.Api.Client.IQueryTrait< ByProjectKeyMessagesGet >, commercetools.Sdk.Api.Client.IErrorableTrait< ByProjectKeyMessagesGet >, and commercetools.Sdk.Api.Client.IDeprecatable200Trait< ByProjectKeyMessagesGet >.

Public Member Functions
	ByProjectKeyMessagesGet (IClient apiHttpClient, string projectKey)
List< string >	GetExpand ()
List< string >	GetSort ()
List< string >	GetLimit ()
List< string >	GetOffset ()
List< string >	GetWithTotal ()
List< string >	GetWhere ()
ByProjectKeyMessagesGet	WithExpand (string expand)
ByProjectKeyMessagesGet	WithSort (string sort)
ByProjectKeyMessagesGet	WithLimit (long limit)
ByProjectKeyMessagesGet	WithOffset (long offset)
ByProjectKeyMessagesGet	WithWithTotal (bool withTotal)
ByProjectKeyMessagesGet	WithWhere (string where)
ByProjectKeyMessagesGet	WithPredicateVar (string varName, string predicateVar)
async Task< commercetools.Sdk.Api.Models.Messages.IMessagePagedQueryResponse >	ExecuteAsync (CancellationToken cancellationToken=default)
async Task< string >	ExecuteAsJsonAsync (CancellationToken cancellationToken=default)
async Task< IApiResponse< commercetools.Sdk.Api.Models.Messages.IMessagePagedQueryResponse > >	SendAsync (CancellationToken cancellationToken=default)
async Task< IApiResponse< string > >	SendAsJsonAsync (CancellationToken cancellationToken=default)
Public Member Functions inherited from commercetools.Sdk.Api.Client.IPagedQueryResourceRequest< ByProjectKeyMessagesGet, IMessagePagedQueryResponse, MessageQueryBuilderDsl >
T	WithExpand (string expand)
Public Member Functions inherited from commercetools.Sdk.Api.Models.IPagedQueryResourceRequest< ByProjectKeyMessagesGet, commercetools.Sdk.Api.Models.Messages.IMessagePagedQueryResponse >
T	WithLimit (long limit)
T	WithOffset (long offset)
T	WithSort (string sort)
T	WithWhere (string where)
T	WithExpand (string expand)
T	WithWithTotal (bool withTotal)
T	WithPredicateVar (string varName, string predicateVar)
List< string >	GetQueryParam (string key)
Public Member Functions inherited from commercetools.Base.Client.ApiMethod< ByProjectKeyMessagesGet >
	ApiMethod ()
T	AddQueryParam (string key, string value)
T	WithQueryParam (List< KeyValuePair< string, string > > queryParams)
ICollection< KeyValuePair< string, string > >	GetQueryParams ()
List< string >	GetQueryParam (string key)
string?	GetFirstQueryParam (string key)
T	AddHeader (string key, string value)
T	WithHeaders (ApiHttpHeaders headers)
virtual HttpRequestMessage	Build ()
Public Member Functions inherited from commercetools.Base.Client.IApiMethod< ByProjectKeyMessagesGet, commercetools.Sdk.Api.Models.Messages.IMessagePagedQueryResponse >
T	AddQueryParam (string key, string value)
T	WithQueryParam (List< KeyValuePair< string, string > > queryParams)
List< string >	GetQueryParam (string key)
T	AddHeader (string key, string value)
T	WithHeaders (ApiHttpHeaders headers)
HttpRequestMessage	Build ()
Task< TResult >	ExecuteAsync (CancellationToken cancellationToken=default)
Task< IApiResponse< TResult > >	SendAsync (CancellationToken cancellationToken=default)
Task< string >	ExecuteAsJsonAsync (CancellationToken cancellationToken=default)
Task< IApiResponse< string > >	SendAsJsonAsync (CancellationToken cancellationToken=default)
Public Member Functions inherited from commercetools.Sdk.Api.Client.IExpandableTrait< ByProjectKeyMessagesGet >
List< string >	GetExpand ()
T	WithExpand (string expand)
IExpandableTrait< T >	AsExpandableTrait ()
T	AsExpandableTraitToBaseType ()
Public Member Functions inherited from commercetools.Sdk.Api.Client.ISortableTrait< ByProjectKeyMessagesGet >
List< string >	GetSort ()
T	WithSort (string sort)
ISortableTrait< T >	AsSortableTrait ()
T	AsSortableTraitToBaseType ()
Public Member Functions inherited from commercetools.Sdk.Api.Client.IPagingTrait< ByProjectKeyMessagesGet >
List< string >	GetLimit ()
List< string >	GetOffset ()
List< string >	GetWithTotal ()
T	WithLimit (long limit)
T	WithOffset (long offset)
T	WithWithTotal (bool withTotal)
IPagingTrait< T >	AsPagingTrait ()
T	AsPagingTraitToBaseType ()
Public Member Functions inherited from commercetools.Sdk.Api.Client.IQueryTrait< ByProjectKeyMessagesGet >
List< string >	GetWhere ()
T	WithWhere (string where)
T	WithPredicateVar (string varName, string predicateVar)
IQueryTrait< T >	AsQueryTrait ()
T	AsQueryTraitToBaseType ()
Public Member Functions inherited from commercetools.Sdk.Api.Client.IErrorableTrait< ByProjectKeyMessagesGet >
IErrorableTrait< T >	AsErrorableTrait ()
T	AsErrorableTraitToBaseType ()
Public Member Functions inherited from commercetools.Sdk.Api.Client.IDeprecatable200Trait< ByProjectKeyMessagesGet >
IDeprecatable200Trait< T >	AsDeprecatable200Trait ()
T	AsDeprecatable200TraitToBaseType ()

Properties
override HttpMethod	Method [get]
Properties inherited from commercetools.Base.Client.ApiMethod< ByProjectKeyMessagesGet >
HttpMethod	Method [get]
string	RequestUrl [get, set]
ApiHttpHeaders	Headers [get, set]
Properties inherited from commercetools.Base.Client.IApiMethod< ByProjectKeyMessagesGet, commercetools.Sdk.Api.Models.Messages.IMessagePagedQueryResponse >
HttpMethod	Method [get]
string	RequestUrl [get, set]

Constructor & Destructor Documentation

ByProjectKeyMessagesGet()

commercetools.Sdk.Api.Client.RequestBuilders.Messages.ByProjectKeyMessagesGet.ByProjectKeyMessagesGet ( IClient  apiHttpClient, string  projectKey  )

inline

Member Function Documentation

ExecuteAsJsonAsync()

async Task< string > commercetools.Sdk.Api.Client.RequestBuilders.Messages.ByProjectKeyMessagesGet.ExecuteAsJsonAsync ( CancellationToken  cancellationToken = default )

inline

ExecuteAsync()

async Task< commercetools.Sdk.Api.Models.Messages.IMessagePagedQueryResponse > commercetools.Sdk.Api.Client.RequestBuilders.Messages.ByProjectKeyMessagesGet.ExecuteAsync ( CancellationToken  cancellationToken = default )

inline

GetExpand()

List< string > commercetools.Sdk.Api.Client.RequestBuilders.Messages.ByProjectKeyMessagesGet.GetExpand ( )

inline

GetLimit()

List< string > commercetools.Sdk.Api.Client.RequestBuilders.Messages.ByProjectKeyMessagesGet.GetLimit ( )

inline

GetOffset()

List< string > commercetools.Sdk.Api.Client.RequestBuilders.Messages.ByProjectKeyMessagesGet.GetOffset ( )

inline

GetSort()

List< string > commercetools.Sdk.Api.Client.RequestBuilders.Messages.ByProjectKeyMessagesGet.GetSort ( )

inline

GetWhere()

List< string > commercetools.Sdk.Api.Client.RequestBuilders.Messages.ByProjectKeyMessagesGet.GetWhere ( )

inline

GetWithTotal()

List< string > commercetools.Sdk.Api.Client.RequestBuilders.Messages.ByProjectKeyMessagesGet.GetWithTotal ( )

inline

SendAsJsonAsync()

async Task< IApiResponse< string > > commercetools.Sdk.Api.Client.RequestBuilders.Messages.ByProjectKeyMessagesGet.SendAsJsonAsync ( CancellationToken  cancellationToken = default )

inline

SendAsync()

async Task< IApiResponse< commercetools.Sdk.Api.Models.Messages.IMessagePagedQueryResponse > > commercetools.Sdk.Api.Client.RequestBuilders.Messages.ByProjectKeyMessagesGet.SendAsync ( CancellationToken  cancellationToken = default )

inline

WithExpand()

ByProjectKeyMessagesGet commercetools.Sdk.Api.Client.RequestBuilders.Messages.ByProjectKeyMessagesGet.WithExpand ( string  expand )

inline

WithLimit()

ByProjectKeyMessagesGet commercetools.Sdk.Api.Client.RequestBuilders.Messages.ByProjectKeyMessagesGet.WithLimit ( long  limit )

inline

WithOffset()

ByProjectKeyMessagesGet commercetools.Sdk.Api.Client.RequestBuilders.Messages.ByProjectKeyMessagesGet.WithOffset ( long  offset )

inline

WithPredicateVar()

ByProjectKeyMessagesGet commercetools.Sdk.Api.Client.RequestBuilders.Messages.ByProjectKeyMessagesGet.WithPredicateVar ( string  varName, string  predicateVar  )

inline

WithSort()

ByProjectKeyMessagesGet commercetools.Sdk.Api.Client.RequestBuilders.Messages.ByProjectKeyMessagesGet.WithSort ( string  sort )

inline

WithWhere()

ByProjectKeyMessagesGet commercetools.Sdk.Api.Client.RequestBuilders.Messages.ByProjectKeyMessagesGet.WithWhere ( string  where )

inline

WithWithTotal()

ByProjectKeyMessagesGet commercetools.Sdk.Api.Client.RequestBuilders.Messages.ByProjectKeyMessagesGet.WithWithTotal ( bool  withTotal )

inline

Property Documentation

Method

override HttpMethod commercetools.Sdk.Api.Client.RequestBuilders.Messages.ByProjectKeyMessagesGet.Method

get

---

The documentation for this class was generated from the following files:

• commercetools.Sdk/commercetools.Sdk.Api/Client/RequestBuilders/Messages/ByProjectKeyMessagesGet.cs
• commercetools.Sdk/commercetools.Sdk.Api/Generated/Client/RequestBuilders/Messages/ByProjectKeyMessagesGet.cs