GoogleCloudContactcenterinsightsV1mainConversationParticipant.php 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170
  1. <?php
  2. /*
  3. * Copyright 2014 Google Inc.
  4. *
  5. * Licensed under the Apache License, Version 2.0 (the "License"); you may not
  6. * use this file except in compliance with the License. You may obtain a copy of
  7. * 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, WITHOUT
  13. * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  14. * License for the specific language governing permissions and limitations under
  15. * the License.
  16. */
  17. namespace Google\Service\Contactcenterinsights;
  18. class GoogleCloudContactcenterinsightsV1mainConversationParticipant extends \Google\Model
  19. {
  20. /**
  21. * Participant's role is not set.
  22. */
  23. public const ROLE_ROLE_UNSPECIFIED = 'ROLE_UNSPECIFIED';
  24. /**
  25. * Participant is a human agent.
  26. */
  27. public const ROLE_HUMAN_AGENT = 'HUMAN_AGENT';
  28. /**
  29. * Participant is an automated agent.
  30. */
  31. public const ROLE_AUTOMATED_AGENT = 'AUTOMATED_AGENT';
  32. /**
  33. * Participant is an end user who conversed with the contact center.
  34. */
  35. public const ROLE_END_USER = 'END_USER';
  36. /**
  37. * Participant is either a human or automated agent.
  38. */
  39. public const ROLE_ANY_AGENT = 'ANY_AGENT';
  40. /**
  41. * Deprecated. Use `dialogflow_participant_name` instead. The name of the
  42. * Dialogflow participant. Format: projects/{project}/locations/{location}/con
  43. * versations/{conversation}/participants/{participant}
  44. *
  45. * @deprecated
  46. * @var string
  47. */
  48. public $dialogflowParticipant;
  49. /**
  50. * The name of the participant provided by Dialogflow. Format: projects/{proje
  51. * ct}/locations/{location}/conversations/{conversation}/participants/{partici
  52. * pant}
  53. *
  54. * @var string
  55. */
  56. public $dialogflowParticipantName;
  57. /**
  58. * Obfuscated user ID from Dialogflow.
  59. *
  60. * @var string
  61. */
  62. public $obfuscatedExternalUserId;
  63. /**
  64. * The role of the participant.
  65. *
  66. * @var string
  67. */
  68. public $role;
  69. /**
  70. * A user-specified ID representing the participant.
  71. *
  72. * @var string
  73. */
  74. public $userId;
  75. /**
  76. * Deprecated. Use `dialogflow_participant_name` instead. The name of the
  77. * Dialogflow participant. Format: projects/{project}/locations/{location}/con
  78. * versations/{conversation}/participants/{participant}
  79. *
  80. * @deprecated
  81. * @param string $dialogflowParticipant
  82. */
  83. public function setDialogflowParticipant($dialogflowParticipant)
  84. {
  85. $this->dialogflowParticipant = $dialogflowParticipant;
  86. }
  87. /**
  88. * @deprecated
  89. * @return string
  90. */
  91. public function getDialogflowParticipant()
  92. {
  93. return $this->dialogflowParticipant;
  94. }
  95. /**
  96. * The name of the participant provided by Dialogflow. Format: projects/{proje
  97. * ct}/locations/{location}/conversations/{conversation}/participants/{partici
  98. * pant}
  99. *
  100. * @param string $dialogflowParticipantName
  101. */
  102. public function setDialogflowParticipantName($dialogflowParticipantName)
  103. {
  104. $this->dialogflowParticipantName = $dialogflowParticipantName;
  105. }
  106. /**
  107. * @return string
  108. */
  109. public function getDialogflowParticipantName()
  110. {
  111. return $this->dialogflowParticipantName;
  112. }
  113. /**
  114. * Obfuscated user ID from Dialogflow.
  115. *
  116. * @param string $obfuscatedExternalUserId
  117. */
  118. public function setObfuscatedExternalUserId($obfuscatedExternalUserId)
  119. {
  120. $this->obfuscatedExternalUserId = $obfuscatedExternalUserId;
  121. }
  122. /**
  123. * @return string
  124. */
  125. public function getObfuscatedExternalUserId()
  126. {
  127. return $this->obfuscatedExternalUserId;
  128. }
  129. /**
  130. * The role of the participant.
  131. *
  132. * Accepted values: ROLE_UNSPECIFIED, HUMAN_AGENT, AUTOMATED_AGENT, END_USER,
  133. * ANY_AGENT
  134. *
  135. * @param self::ROLE_* $role
  136. */
  137. public function setRole($role)
  138. {
  139. $this->role = $role;
  140. }
  141. /**
  142. * @return self::ROLE_*
  143. */
  144. public function getRole()
  145. {
  146. return $this->role;
  147. }
  148. /**
  149. * A user-specified ID representing the participant.
  150. *
  151. * @param string $userId
  152. */
  153. public function setUserId($userId)
  154. {
  155. $this->userId = $userId;
  156. }
  157. /**
  158. * @return string
  159. */
  160. public function getUserId()
  161. {
  162. return $this->userId;
  163. }
  164. }
  165. // Adding a class alias for backwards compatibility with the previous class name.
  166. class_alias(GoogleCloudContactcenterinsightsV1mainConversationParticipant::class, 'Google_Service_Contactcenterinsights_GoogleCloudContactcenterinsightsV1mainConversationParticipant');