AlexaForBusinessClient Class

Member Function Documentation

AlexaForBusinessClient::AlexaForBusinessClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a AlexaForBusinessClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

AlexaForBusinessClient::AlexaForBusinessClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads AlexaForBusinessClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] AssociateContactWithAddressBookResponse *AlexaForBusinessClient::associateContactWithAddressBook(const AssociateContactWithAddressBookRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an AssociateContactWithAddressBookResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Associates a contact with a given address

[slot] AssociateDeviceWithRoomResponse *AlexaForBusinessClient::associateDeviceWithRoom(const AssociateDeviceWithRoomRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an AssociateDeviceWithRoomResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Associates a device with a given room. This applies all the settings from the room profile to the device, and all the skills in any skill groups added to that room. This operation requires the device to be online, or else a manual sync is required.

[slot] AssociateSkillGroupWithRoomResponse *AlexaForBusinessClient::associateSkillGroupWithRoom(const AssociateSkillGroupWithRoomRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an AssociateSkillGroupWithRoomResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Associates a skill group with a given room. This enables all skills in the associated skill group on all devices in the

[slot] CreateAddressBookResponse *AlexaForBusinessClient::createAddressBook(const CreateAddressBookRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an CreateAddressBookResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates an address book with the specified

[slot] CreateContactResponse *AlexaForBusinessClient::createContact(const CreateContactRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an CreateContactResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a contact with the specified

[slot] CreateProfileResponse *AlexaForBusinessClient::createProfile(const CreateProfileRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an CreateProfileResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a new room profile with the specified

[slot] CreateRoomResponse *AlexaForBusinessClient::createRoom(const CreateRoomRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an CreateRoomResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a room with the specified

[slot] CreateSkillGroupResponse *AlexaForBusinessClient::createSkillGroup(const CreateSkillGroupRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an CreateSkillGroupResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a skill group with a specified name and

[slot] CreateUserResponse *AlexaForBusinessClient::createUser(const CreateUserRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an CreateUserResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a

[slot] DeleteAddressBookResponse *AlexaForBusinessClient::deleteAddressBook(const DeleteAddressBookRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an DeleteAddressBookResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes an address book by the address book

[slot] DeleteContactResponse *AlexaForBusinessClient::deleteContact(const DeleteContactRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an DeleteContactResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes a contact by the contact

[slot] DeleteProfileResponse *AlexaForBusinessClient::deleteProfile(const DeleteProfileRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an DeleteProfileResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes a room profile by the profile

[slot] DeleteRoomResponse *AlexaForBusinessClient::deleteRoom(const DeleteRoomRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an DeleteRoomResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes a room by the room

[slot] DeleteRoomSkillParameterResponse *AlexaForBusinessClient::deleteRoomSkillParameter(const DeleteRoomSkillParameterRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an DeleteRoomSkillParameterResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes room skill parameter details by room, skill, and parameter key

[slot] DeleteSkillGroupResponse *AlexaForBusinessClient::deleteSkillGroup(const DeleteSkillGroupRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an DeleteSkillGroupResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes a skill group by skill group

[slot] DeleteUserResponse *AlexaForBusinessClient::deleteUser(const DeleteUserRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an DeleteUserResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes a specified user by user ARN and enrollment

[slot] DisassociateContactFromAddressBookResponse *AlexaForBusinessClient::disassociateContactFromAddressBook(const DisassociateContactFromAddressBookRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an DisassociateContactFromAddressBookResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Disassociates a contact from a given address

[slot] DisassociateDeviceFromRoomResponse *AlexaForBusinessClient::disassociateDeviceFromRoom(const DisassociateDeviceFromRoomRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an DisassociateDeviceFromRoomResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Disassociates a device from its current room. The device continues to be connected to the Wi-Fi network and is still registered to the account. The device settings and skills are removed from the

[slot] DisassociateSkillGroupFromRoomResponse *AlexaForBusinessClient::disassociateSkillGroupFromRoom(const DisassociateSkillGroupFromRoomRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an DisassociateSkillGroupFromRoomResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Disassociates a skill group from a specified room. This disables all skills in the skill group on all devices in the

[slot] GetAddressBookResponse *AlexaForBusinessClient::getAddressBook(const GetAddressBookRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an GetAddressBookResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets address the book details by the address book

[slot] GetContactResponse *AlexaForBusinessClient::getContact(const GetContactRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an GetContactResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets the contact details by the contact

[slot] GetDeviceResponse *AlexaForBusinessClient::getDevice(const GetDeviceRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an GetDeviceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets the details of a device by device

[slot] GetProfileResponse *AlexaForBusinessClient::getProfile(const GetProfileRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an GetProfileResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets the details of a room profile by profile

[slot] GetRoomResponse *AlexaForBusinessClient::getRoom(const GetRoomRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an GetRoomResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets room details by room

[slot] GetRoomSkillParameterResponse *AlexaForBusinessClient::getRoomSkillParameter(const GetRoomSkillParameterRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an GetRoomSkillParameterResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets room skill parameter details by room, skill, and parameter key

[slot] GetSkillGroupResponse *AlexaForBusinessClient::getSkillGroup(const GetSkillGroupRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an GetSkillGroupResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets skill group details by skill group

[slot] ListDeviceEventsResponse *AlexaForBusinessClient::listDeviceEvents(const ListDeviceEventsRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an ListDeviceEventsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists the Device Event history for up to 30 days. If EventType isn't specified in the request, this returns a list of all device events in reverse chronological order. If EventType is specified, this returns a list of device events for that EventType in reverse chronological order.

[slot] ListSkillsResponse *AlexaForBusinessClient::listSkills(const ListSkillsRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an ListSkillsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists all enabled skills in a specific skill

[slot] ListTagsResponse *AlexaForBusinessClient::listTags(const ListTagsRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an ListTagsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists all tags for a specific

[slot] PutRoomSkillParameterResponse *AlexaForBusinessClient::putRoomSkillParameter(const PutRoomSkillParameterRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an PutRoomSkillParameterResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill

[slot] ResolveRoomResponse *AlexaForBusinessClient::resolveRoom(const ResolveRoomRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an ResolveRoomResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Determines the details for the room from which a skill request was invoked. This operation is used by skill

[slot] RevokeInvitationResponse *AlexaForBusinessClient::revokeInvitation(const RevokeInvitationRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an RevokeInvitationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Revokes an invitation and invalidates the enrollment

[slot] SearchAddressBooksResponse *AlexaForBusinessClient::searchAddressBooks(const SearchAddressBooksRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an SearchAddressBooksResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Searches address books and lists the ones that meet a set of filter and sort

[slot] SearchContactsResponse *AlexaForBusinessClient::searchContacts(const SearchContactsRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an SearchContactsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Searches contacts and lists the ones that meet a set of filter and sort

[slot] SearchDevicesResponse *AlexaForBusinessClient::searchDevices(const SearchDevicesRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an SearchDevicesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Searches devices and lists the ones that meet a set of filter

[slot] SearchProfilesResponse *AlexaForBusinessClient::searchProfiles(const SearchProfilesRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an SearchProfilesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Searches room profiles and lists the ones that meet a set of filter

[slot] SearchRoomsResponse *AlexaForBusinessClient::searchRooms(const SearchRoomsRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an SearchRoomsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Searches rooms and lists the ones that meet a set of filter and sort

[slot] SearchSkillGroupsResponse *AlexaForBusinessClient::searchSkillGroups(const SearchSkillGroupsRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an SearchSkillGroupsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Searches skill groups and lists the ones that meet a set of filter and sort

[slot] SearchUsersResponse *AlexaForBusinessClient::searchUsers(const SearchUsersRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an SearchUsersResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Searches users and lists the ones that meet a set of filter and sort

[slot] SendInvitationResponse *AlexaForBusinessClient::sendInvitation(const SendInvitationRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an SendInvitationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Sends an enrollment invitation email with a URL to a user. The URL is valid for 72 hours or until you call this operation again, whichever comes first.

[slot] StartDeviceSyncResponse *AlexaForBusinessClient::startDeviceSync(const StartDeviceSyncRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an StartDeviceSyncResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Resets a device and its account to the known default settings, by clearing all information and settings set by previous

[slot] TagResourceResponse *AlexaForBusinessClient::tagResource(const TagResourceRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an TagResourceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Adds metadata tags to a specified

[slot] UntagResourceResponse *AlexaForBusinessClient::untagResource(const UntagResourceRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an UntagResourceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Removes metadata tags from a specified

[slot] UpdateAddressBookResponse *AlexaForBusinessClient::updateAddressBook(const UpdateAddressBookRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an UpdateAddressBookResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates address book details by the address book

[slot] UpdateContactResponse *AlexaForBusinessClient::updateContact(const UpdateContactRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an UpdateContactResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates the contact details by the contact

[slot] UpdateDeviceResponse *AlexaForBusinessClient::updateDevice(const UpdateDeviceRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an UpdateDeviceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates the device name by device

[slot] UpdateProfileResponse *AlexaForBusinessClient::updateProfile(const UpdateProfileRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an UpdateProfileResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates an existing room profile by room profile

[slot] UpdateRoomResponse *AlexaForBusinessClient::updateRoom(const UpdateRoomRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an UpdateRoomResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates room details by room

[slot] UpdateSkillGroupResponse *AlexaForBusinessClient::updateSkillGroup(const UpdateSkillGroupRequest &request)

Sends request to the AlexaForBusinessClient service, and returns a pointer to an UpdateSkillGroupResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates skill group details by skill group