AWS SDK for C++  1.8.54
AWS SDK for C++
Public Member Functions | List of all members
Aws::AlexaForBusiness::Model::SearchContactsRequest Class Reference

#include <SearchContactsRequest.h>

+ Inheritance diagram for Aws::AlexaForBusiness::Model::SearchContactsRequest:

Public Member Functions

 SearchContactsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::Vector< Filter > & GetFilters () const
 
bool FiltersHasBeenSet () const
 
void SetFilters (const Aws::Vector< Filter > &value)
 
void SetFilters (Aws::Vector< Filter > &&value)
 
SearchContactsRequestWithFilters (const Aws::Vector< Filter > &value)
 
SearchContactsRequestWithFilters (Aws::Vector< Filter > &&value)
 
SearchContactsRequestAddFilters (const Filter &value)
 
SearchContactsRequestAddFilters (Filter &&value)
 
const Aws::Vector< Sort > & GetSortCriteria () const
 
bool SortCriteriaHasBeenSet () const
 
void SetSortCriteria (const Aws::Vector< Sort > &value)
 
void SetSortCriteria (Aws::Vector< Sort > &&value)
 
SearchContactsRequestWithSortCriteria (const Aws::Vector< Sort > &value)
 
SearchContactsRequestWithSortCriteria (Aws::Vector< Sort > &&value)
 
SearchContactsRequestAddSortCriteria (const Sort &value)
 
SearchContactsRequestAddSortCriteria (Sort &&value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
SearchContactsRequestWithNextToken (const Aws::String &value)
 
SearchContactsRequestWithNextToken (Aws::String &&value)
 
SearchContactsRequestWithNextToken (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
SearchContactsRequestWithMaxResults (int value)
 
- Public Member Functions inherited from Aws::AlexaForBusiness::AlexaForBusinessRequest
virtual ~AlexaForBusinessRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 24 of file SearchContactsRequest.h.

Constructor & Destructor Documentation

◆ SearchContactsRequest()

Aws::AlexaForBusiness::Model::SearchContactsRequest::SearchContactsRequest ( )

Member Function Documentation

◆ AddFilters() [1/2]

SearchContactsRequest& Aws::AlexaForBusiness::Model::SearchContactsRequest::AddFilters ( const Filter value)
inline

The filters to use to list a specified set of address books. The supported filter keys are DisplayName, FirstName, LastName, and AddressBookArns.

Definition at line 80 of file SearchContactsRequest.h.

◆ AddFilters() [2/2]

SearchContactsRequest& Aws::AlexaForBusiness::Model::SearchContactsRequest::AddFilters ( Filter &&  value)
inline

The filters to use to list a specified set of address books. The supported filter keys are DisplayName, FirstName, LastName, and AddressBookArns.

Definition at line 86 of file SearchContactsRequest.h.

◆ AddSortCriteria() [1/2]

SearchContactsRequest& Aws::AlexaForBusiness::Model::SearchContactsRequest::AddSortCriteria ( const Sort value)
inline

The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName, FirstName, and LastName.

Definition at line 129 of file SearchContactsRequest.h.

◆ AddSortCriteria() [2/2]

SearchContactsRequest& Aws::AlexaForBusiness::Model::SearchContactsRequest::AddSortCriteria ( Sort &&  value)
inline

The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName, FirstName, and LastName.

Definition at line 135 of file SearchContactsRequest.h.

◆ FiltersHasBeenSet()

bool Aws::AlexaForBusiness::Model::SearchContactsRequest::FiltersHasBeenSet ( ) const
inline

The filters to use to list a specified set of address books. The supported filter keys are DisplayName, FirstName, LastName, and AddressBookArns.

Definition at line 50 of file SearchContactsRequest.h.

◆ GetFilters()

const Aws::Vector<Filter>& Aws::AlexaForBusiness::Model::SearchContactsRequest::GetFilters ( ) const
inline

The filters to use to list a specified set of address books. The supported filter keys are DisplayName, FirstName, LastName, and AddressBookArns.

Definition at line 44 of file SearchContactsRequest.h.

◆ GetMaxResults()

int Aws::AlexaForBusiness::Model::SearchContactsRequest::GetMaxResults ( ) const
inline

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

Definition at line 208 of file SearchContactsRequest.h.

◆ GetNextToken()

const Aws::String& Aws::AlexaForBusiness::Model::SearchContactsRequest::GetNextToken ( ) const
inline

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.

Definition at line 144 of file SearchContactsRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::AlexaForBusiness::Model::SearchContactsRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::AlexaForBusiness::Model::SearchContactsRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file SearchContactsRequest.h.

◆ GetSortCriteria()

const Aws::Vector<Sort>& Aws::AlexaForBusiness::Model::SearchContactsRequest::GetSortCriteria ( ) const
inline

The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName, FirstName, and LastName.

Definition at line 93 of file SearchContactsRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::AlexaForBusiness::Model::SearchContactsRequest::MaxResultsHasBeenSet ( ) const
inline

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

Definition at line 215 of file SearchContactsRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::AlexaForBusiness::Model::SearchContactsRequest::NextTokenHasBeenSet ( ) const
inline

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.

Definition at line 152 of file SearchContactsRequest.h.

◆ SerializePayload()

Aws::String Aws::AlexaForBusiness::Model::SearchContactsRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetFilters() [1/2]

void Aws::AlexaForBusiness::Model::SearchContactsRequest::SetFilters ( const Aws::Vector< Filter > &  value)
inline

The filters to use to list a specified set of address books. The supported filter keys are DisplayName, FirstName, LastName, and AddressBookArns.

Definition at line 56 of file SearchContactsRequest.h.

◆ SetFilters() [2/2]

void Aws::AlexaForBusiness::Model::SearchContactsRequest::SetFilters ( Aws::Vector< Filter > &&  value)
inline

The filters to use to list a specified set of address books. The supported filter keys are DisplayName, FirstName, LastName, and AddressBookArns.

Definition at line 62 of file SearchContactsRequest.h.

◆ SetMaxResults()

void Aws::AlexaForBusiness::Model::SearchContactsRequest::SetMaxResults ( int  value)
inline

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

Definition at line 222 of file SearchContactsRequest.h.

◆ SetNextToken() [1/3]

void Aws::AlexaForBusiness::Model::SearchContactsRequest::SetNextToken ( const Aws::String value)
inline

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.

Definition at line 160 of file SearchContactsRequest.h.

◆ SetNextToken() [2/3]

void Aws::AlexaForBusiness::Model::SearchContactsRequest::SetNextToken ( Aws::String &&  value)
inline

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.

Definition at line 168 of file SearchContactsRequest.h.

◆ SetNextToken() [3/3]

void Aws::AlexaForBusiness::Model::SearchContactsRequest::SetNextToken ( const char *  value)
inline

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.

Definition at line 176 of file SearchContactsRequest.h.

◆ SetSortCriteria() [1/2]

void Aws::AlexaForBusiness::Model::SearchContactsRequest::SetSortCriteria ( const Aws::Vector< Sort > &  value)
inline

The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName, FirstName, and LastName.

Definition at line 105 of file SearchContactsRequest.h.

◆ SetSortCriteria() [2/2]

void Aws::AlexaForBusiness::Model::SearchContactsRequest::SetSortCriteria ( Aws::Vector< Sort > &&  value)
inline

The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName, FirstName, and LastName.

Definition at line 111 of file SearchContactsRequest.h.

◆ SortCriteriaHasBeenSet()

bool Aws::AlexaForBusiness::Model::SearchContactsRequest::SortCriteriaHasBeenSet ( ) const
inline

The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName, FirstName, and LastName.

Definition at line 99 of file SearchContactsRequest.h.

◆ WithFilters() [1/2]

SearchContactsRequest& Aws::AlexaForBusiness::Model::SearchContactsRequest::WithFilters ( const Aws::Vector< Filter > &  value)
inline

The filters to use to list a specified set of address books. The supported filter keys are DisplayName, FirstName, LastName, and AddressBookArns.

Definition at line 68 of file SearchContactsRequest.h.

◆ WithFilters() [2/2]

SearchContactsRequest& Aws::AlexaForBusiness::Model::SearchContactsRequest::WithFilters ( Aws::Vector< Filter > &&  value)
inline

The filters to use to list a specified set of address books. The supported filter keys are DisplayName, FirstName, LastName, and AddressBookArns.

Definition at line 74 of file SearchContactsRequest.h.

◆ WithMaxResults()

SearchContactsRequest& Aws::AlexaForBusiness::Model::SearchContactsRequest::WithMaxResults ( int  value)
inline

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

Definition at line 229 of file SearchContactsRequest.h.

◆ WithNextToken() [1/3]

SearchContactsRequest& Aws::AlexaForBusiness::Model::SearchContactsRequest::WithNextToken ( const Aws::String value)
inline

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.

Definition at line 184 of file SearchContactsRequest.h.

◆ WithNextToken() [2/3]

SearchContactsRequest& Aws::AlexaForBusiness::Model::SearchContactsRequest::WithNextToken ( Aws::String &&  value)
inline

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.

Definition at line 192 of file SearchContactsRequest.h.

◆ WithNextToken() [3/3]

SearchContactsRequest& Aws::AlexaForBusiness::Model::SearchContactsRequest::WithNextToken ( const char *  value)
inline

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.

Definition at line 200 of file SearchContactsRequest.h.

◆ WithSortCriteria() [1/2]

SearchContactsRequest& Aws::AlexaForBusiness::Model::SearchContactsRequest::WithSortCriteria ( const Aws::Vector< Sort > &  value)
inline

The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName, FirstName, and LastName.

Definition at line 117 of file SearchContactsRequest.h.

◆ WithSortCriteria() [2/2]

SearchContactsRequest& Aws::AlexaForBusiness::Model::SearchContactsRequest::WithSortCriteria ( Aws::Vector< Sort > &&  value)
inline

The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName, FirstName, and LastName.

Definition at line 123 of file SearchContactsRequest.h.


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