Class UserSecretService
Defined in File UserSecretService.h
Page Contents
Inheritance Relationships
Base Type
public axr::sdk::ServiceBase< UserSecret >
(Template Class ServiceBase)
Class Documentation
-
class UserSecretService : public axr::sdk::ServiceBase<UserSecret>
Public Functions
-
inline ~UserSecretService()
-
pplx::task<std::vector<std::shared_ptr<UserSecret>>> FindAll(const utility::string_t &userId, const std::map<utility::string_t, utility::string_t> *searchParams = nullptr, const uint16_t startIndex = 0, const uint16_t maxResults = 1000, const utility::string_t &sortBy = _XPLATSTR(""))
Retrieves a list of objects matching the specified search parameters.
- Parameters
userId – The userId value which uniquely idenitifies the object.
searchParams – A map of property names to values to search for.
startIndex – The index of the first object to include in the result.
maxResults – The maximum number of objects to evaluate during the search.
sortBy – The property name and order direction to sort the results using. (e.g. “MyProperty=ASC” to sort by MyProperty in ascending order, “MyProperty=DESC” to sort by MyProperty in descending order).
- Returns
A task whose result is a list of objects matching the specified search parameters.
Creates a new instance of UserSecret, storing the object on the remote service and returning the final result.
- Parameters
userId – The userId value which uniquely idenitifies the object.
obj – The object to persist with the remote service.
- Returns
A task whose result is the final object as it was persisted with the remote service.
-
pplx::task<std::shared_ptr<UserSecret>> FindById(const utility::string_t &userId, const utility::string_t &id)
Retrieves an instance of UserSecret with the specified unique identifier.
- Parameters
userId – The userId value which uniquely idenitifies the object.
id – The id value which uniquely idenitifies the object.
- Returns
A task whose result is the object with the specified identifier if found.
Updates an existing instance of UserSecret, storing the object on the remote service and returning the final result.
- Parameters
userId – The userId value which uniquely idenitifies the object.
id – The id value which uniquely idenitifies the object.
obj – The object to update with the remote service.
- Returns
A task whose result is the final object as it was persisted with the remote service.
-
pplx::task<void> Delete(const utility::string_t &userId, const utility::string_t &id)
Deletes an instance of UserSecret with the specified unique identifier.
- Parameters
userId – The userId value which uniquely idenitifies the object.
id – The id value which uniquely idenitifies the object.
- Returns
A task.
Public Static Functions
-
static inline const utility::char_t *ClassName()
Returns the fully qualified name of the class.
-
inline ~UserSecretService()