src/app/clusters/groups-server/groups-server.h

   1 /**
   2  *
   3  *    Copyright (c) 2020 Project CHIP Authors
   4  *
   5  *    Licensed under the Apache License, Version 2.0 (the "License");
   6  *    you may not use this file except in compliance with the License.
   7  *    You may obtain a copy of the License at
   8  *
   9  *        http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  *    Unless required by applicable law or agreed to in writing, software
  12  *    distributed under the License is distributed on an "AS IS" BASIS,
  13  *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  *    See the License for the specific language governing permissions and
  15  *    limitations under the License.
  16  */
  17
  18 #pragma once
  19
  20 #include <app/util/basic-types.h>
  21
  22 /** @brief Get Group Name
  23  *
  24  * This function returns the name of a group with the provided group ID, should
  25  * it exist.
  26  *
  27  * @param endpoint Endpoint Ver.: always
  28  * @param groupId Group ID Ver.: always
  29  * @param groupName Group Name Ver.: always
  30  */
  31 void emberAfPluginGroupsServerGetGroupNameCallback(chip::EndpointId endpoint, chip::GroupId groupId, uint8_t * groupName);
  32
  33 /** @brief Set Group Name
  34  *
  35  * This function sets the name of a group with the provided group ID.
  36  *
  37  * @param endpoint Endpoint Ver.: always
  38  * @param groupId Group ID Ver.: always
  39  * @param groupName Group Name Ver.: always
  40  */
  41 void emberAfPluginGroupsServerSetGroupNameCallback(chip::EndpointId endpoint, chip::GroupId groupId, uint8_t * groupName);
  42
  43 /** @brief Group Names Supported
  44  *
  45  * This function returns whether or not group names are supported.
  46  *
  47  * @param endpoint Endpoint Ver.: always
  48  */
  49 bool emberAfPluginGroupsServerGroupNamesSupportedCallback(chip::EndpointId endpoint);
  50
  51 /** @brief Groups Cluster Endpoint In Group
  52  *
  53  * This function is called by the framework when it needs to determine if an
  54  * endpoint is a member of a group.  The application should return true if the
  55  * endpoint is a member of the group and false otherwise.
  56  *
  57  * @param endpoint The endpoint.  Ver.: always
  58  * @param groupId The group identifier.  Ver.: always
  59  */
  60 bool emberAfGroupsClusterEndpointInGroupCallback(chip::EndpointId endpoint, chip::GroupId groupId);