Aculab Web Services Wrapper (v2.1.0)
\
Aculab
WebServicesWrapper
VoiceBiometrics
Users

\Aculab\WebServicesWrapper\VoiceBiometricsUserGroupKeysWebService

Voice biometrics user group keys web service class

Summary

Methods
Properties
Constants
setWebServicesServer()
setCryptoMethod()
__construct()
listUserGroupKeys()
createUserGroupKey()
modifyUserGroupKey()
deleteUserGroupKey()
No public properties found
VERSION
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Constants

VERSION

VERSION

The wrapper version.

The wrapper version number.

Methods

setWebServicesServer()

setWebServicesServer(string  $wsserver)

Set the web services server address.

This allows the web service requests to be directed to a specific server. The default is https://ws-<cloud_id>.aculabcloud.net

Parameters

string $wsserver

The base URL of the web services server.

setCryptoMethod()

setCryptoMethod(integer  $method)

Set the crypto method used when connectiing to the web services server.

This allows a specific crypto method to be used when connecting to the web service server. The values should be one of the STREAM_CRYPTO_METHOD_TLSv1_N_CLIENT constants. The default is STREAM_CRYPTO_METHOD_ANY_CLIENT.

Parameters

integer $method

The crypto method to use.

__construct()

__construct(string  $cloud_id, string  $username, string  $access_key)

Create a voice biometrics user group keys web service object.

Creates a web service to manage voice biometrics user group keys.

Parameters

string $cloud_id

The cloud region identifier.
string $username

The cloud account username.
string $access_key

The cloud account's access key.

listUserGroupKeys()

listUserGroupKeys(string  $user_group_name) : array

List user group keys.

This lists the details of the user group keys that currently exist.

Parameters

string $user_group_name

The user group name to return details of.

Throws

\Aculab\WebServicesWrapper\WebServiceException

Returns

array —

Returns an array of UserGroupKey objects.

createUserGroupKey()

createUserGroupKey(string  $user_group_name) : \Aculab\WebServicesWrapper\VoiceBiometrics\UserGroupKey

Create a user group key.

This creates a new user group key.

Parameters

string $user_group_name

The name of the user group to create the key in.

Throws

\Aculab\WebServicesWrapper\WebServiceException

Returns

\Aculab\WebServicesWrapper\VoiceBiometrics\UserGroupKey —

The key created.

modifyUserGroupKey()

modifyUserGroupKey(string  $user_group_key, boolean  $enable, boolean  $retain_data) : \Aculab\WebServicesWrapper\VoiceBiometrics\UserGroupKey

Modify a user group key.

This modifies a user group key.

Parameters

string $user_group_key

The key value of the user group key to modify.
boolean $enable

Whether the key should be enabled.
boolean $retain_data

Whether the key is set to retain data for diagnostic purposes.

Throws

\Aculab\WebServicesWrapper\WebServiceException

Returns

\Aculab\WebServicesWrapper\VoiceBiometrics\UserGroupKey —

The modified user group key.

deleteUserGroupKey()

deleteUserGroupKey(string  $user_group_key) : \DateTime

Delete a user group key.

This deletes a user group key.

Parameters

string $user_group_key

The key value of the user group key to delete.

Throws

\Aculab\WebServicesWrapper\WebServiceException

Returns

\DateTime —

The time the group was deleted.