Skip to content

Commit

Permalink
refactor: change parameter documentation
Browse files Browse the repository at this point in the history
use  instead of class name
  • Loading branch information
sualko committed Mar 1, 2021
1 parent db8acef commit c0f1cc4
Show file tree
Hide file tree
Showing 14 changed files with 70 additions and 70 deletions.
68 changes: 34 additions & 34 deletions src/Parameters/CreateMeetingParameters.php
Original file line number Diff line number Diff line change
Expand Up @@ -20,73 +20,73 @@

/**
* @method string getName()
* @method CreateMeetingParameters setName(string $name)
* @method $this setName(string $name)
* @method string getMeetingID()
* @method CreateMeetingParameters setMeetingID(string $id)
* @method $this setMeetingID(string $id)
* @method string getAttendeePW()
* @method CreateMeetingParameters setAttendeePW(string $password)
* @method $this setAttendeePW(string $password)
* @method string getModeratorPW()
* @method CreateMeetingParameters setModeratorPW(string $password)
* @method $this setModeratorPW(string $password)
* @method string getWelcome()
* @method CreateMeetingParameters setWelcome(string $welcome)
* @method $this setWelcome(string $welcome)
* @method string getDialNumber()
* @method CreateMeetingParameters setDialNumber(string $dialNumber)
* @method $this setDialNumber(string $dialNumber)
* @method string getVoiceBridge()
* @method CreateMeetingParameters setVoiceBridge(string $voiceBridge)
* @method $this setVoiceBridge(string $voiceBridge)
* @method int getMaxParticipants()
* @method CreateMeetingParameters setMaxParticipants(int $maxParticipants)
* @method $this setMaxParticipants(int $maxParticipants)
* @method string getLogoutURL()
* @method CreateMeetingParameters setLogoutURL(string $logoutURL)
* @method $this setLogoutURL(string $logoutURL)
* @method bool|null isRecord()
* @method CreateMeetingParameters setRecord(bool $isRecord)
* @method $this setRecord(bool $isRecord)
* @method int getDuration()
* @method CreateMeetingParameters setDuration(int $duration)
* @method $this setDuration(int $duration)
* @method string getParentMeetingID()
* @method CreateMeetingParameters setParentMeetingID(string $parentMeetingID)
* @method $this setParentMeetingID(string $parentMeetingID)
* @method int getSequence()
* @method CreateMeetingParameters setSequence(int $sequence)
* @method $this setSequence(int $sequence)
* @method bool|null isFreeJoin()
* @method CreateMeetingParameters setFreeJoin(bool $isFreeJoin)
* @method $this setFreeJoin(bool $isFreeJoin)
* @method string getModeratorOnlyMessage()
* @method CreateMeetingParameters setModeratorOnlyMessage(string $message)
* @method $this setModeratorOnlyMessage(string $message)
* @method bool|null isAutoStartRecording()
* @method CreateMeetingParameters setAutoStartRecording(bool $isAutoStartRecording)
* @method $this setAutoStartRecording(bool $isAutoStartRecording)
* @method bool|null isAllowStartStopRecording()
* @method CreateMeetingParameters setAllowStartStopRecording(bool $isAllow)
* @method $this setAllowStartStopRecording(bool $isAllow)
* @method bool|null isWebcamsOnlyForModerator()
* @method CreateMeetingParameters setWebcamsOnlyForModerator(bool $isWebcamsOnlyForModerator)
* @method $this setWebcamsOnlyForModerator(bool $isWebcamsOnlyForModerator)
* @method string getLogo()
* @method CreateMeetingParameters setLogo(string $logo)
* @method $this setLogo(string $logo)
* @method string getBannerText()
* @method CreateMeetingParameters setBannerText(string $bannerText)
* @method $this setBannerText(string $bannerText)
* @method string getBannerColor()
* @method CreateMeetingParameters setBannerColor(string $bannerColor)
* @method $this setBannerColor(string $bannerColor)
* @method string getCopyright()
* @method CreateMeetingParameters setCopyright(string $copyright)
* @method $this setCopyright(string $copyright)
* @method bool|null isMuteOnStart()
* @method CreateMeetingParameters setMuteOnStart(bool $isMuteOnStart)
* @method $this setMuteOnStart(bool $isMuteOnStart)
* @method bool|null isAllowModsToUnmuteUsers()
* @method CreateMeetingParameters setAllowModsToUnmuteUsers(bool $isAllowModsToUnmuteUsers)
* @method $this setAllowModsToUnmuteUsers(bool $isAllowModsToUnmuteUsers)
* @method bool|null isLockSettingsDisableCam()
* @method CreateMeetingParameters setLockSettingsDisableCam(bool $isLockSettingsDisableCam)
* @method $this setLockSettingsDisableCam(bool $isLockSettingsDisableCam)
* @method bool|null isLockSettingsDisableMic()
* @method CreateMeetingParameters setLockSettingsDisableMic(bool $isLockSettingsDisableMic)
* @method $this setLockSettingsDisableMic(bool $isLockSettingsDisableMic)
* @method bool|null isLockSettingsDisablePrivateChat()
* @method CreateMeetingParameters setLockSettingsDisablePrivateChat(bool $isLockSettingsDisablePrivateChat)
* @method $this setLockSettingsDisablePrivateChat(bool $isLockSettingsDisablePrivateChat)
* @method bool|null isLockSettingsDisablePublicChat()
* @method CreateMeetingParameters setLockSettingsDisablePublicChat(bool $isLockSettingsDisablePublicChat)
* @method $this setLockSettingsDisablePublicChat(bool $isLockSettingsDisablePublicChat)
* @method bool|null isLockSettingsDisableNote()
* @method CreateMeetingParameters setLockSettingsDisableNote(bool $isLockSettingsDisableNote)
* @method $this setLockSettingsDisableNote(bool $isLockSettingsDisableNote)
* @method bool|null isLockSettingsLockedLayout()
* @method CreateMeetingParameters setLockSettingsLockedLayout(bool $isLockSettingsLockedLayout)
* @method $this setLockSettingsLockedLayout(bool $isLockSettingsLockedLayout)
* @method bool|null isLockSettingsHideUserList()
* @method CreateMeetingParameters setLockSettingsHideUserList(bool $isLockSettingsHideUserList)
* @method $this setLockSettingsHideUserList(bool $isLockSettingsHideUserList)
* @method bool|null isLockSettingsLockOnJoin()
* @method CreateMeetingParameters setLockSettingsLockOnJoin(bool $isLockSettingsLockOnJoin)
* @method $this setLockSettingsLockOnJoin(bool $isLockSettingsLockOnJoin)
* @method bool|null isLockSettingsLockOnJoinConfigurable()
* @method CreateMeetingParameters setLockSettingsLockOnJoinConfigurable(bool $isLockSettingsLockOnJoinConfigurable)
* @method $this setLockSettingsLockOnJoinConfigurable(bool $isLockSettingsLockOnJoinConfigurable)
* @method string getGuestPolicy()
* @method CreateMeetingParameters setGuestPolicy(string $guestPolicy)
* @method $this setGuestPolicy(string $guestPolicy)
*
*/
class CreateMeetingParameters extends MetaParameters
Expand Down
2 changes: 1 addition & 1 deletion src/Parameters/DeleteRecordingsParameters.php
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
* Class DeleteRecordingsParameters
*
* @method string getRecordID()
* @method DeleteRecordingsParameters setRecordID(string $recordID)
* @method $this setRecordID(string $recordID)
*/
class DeleteRecordingsParameters extends BaseParameters
{
Expand Down
4 changes: 2 additions & 2 deletions src/Parameters/EndMeetingParameters.php
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@
* Class EndMeetingParameters.
*
* @method string getMeetingID()
* @method EndMeetingParameters setMeetingID(string $id)
* @method $this setMeetingID(string $id)
* @method string getPassword()
* @method EndMeetingParameters setPassword(string $password)
* @method $this setPassword(string $password)
*/
class EndMeetingParameters extends BaseParameters
{
Expand Down
2 changes: 1 addition & 1 deletion src/Parameters/GetMeetingInfoParameters.php
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
* Class GetMeetingInfoParameters
*
* @method string getMeetingID()
* @method GetMeetingInfoParameters setMeetingID(string $id)
* @method $this setMeetingID(string $id)
*/
class GetMeetingInfoParameters extends BaseParameters
{
Expand Down
2 changes: 1 addition & 1 deletion src/Parameters/GetRecordingTextTracksParameters.php
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
* Class GetRecordingTextTracksParameters
*
* @method string getRecordID()
* @method GetRecordingsParameters setRecordID(string $recordID)
* @method $this setRecordID(string $recordID)
*/
class GetRecordingTextTracksParameters extends MetaParameters
{
Expand Down
6 changes: 3 additions & 3 deletions src/Parameters/GetRecordingsParameters.php
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@
* Class GetRecordingsParameters
*
* @method string getMeetingID()
* @method GetRecordingsParameters setMeetingID(string $id)
* @method $this setMeetingID(string $id)
* @method string getRecordID()
* @method GetRecordingsParameters setRecordID(string $recordID)
* @method $this setRecordID(string $recordID)
* @method string getState()
* @method GetRecordingsParameters setState(string $state)
* @method $this setState(string $state)
*/
class GetRecordingsParameters extends MetaParameters
{
Expand Down
6 changes: 3 additions & 3 deletions src/Parameters/HooksCreateParameters.php
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@

/**
* @method string getCallbackURL()
* @method HooksCreateParameters setCallbackURL(string $url)
* @method $this setCallbackURL(string $url)
* @method string getMeetingID()
* @method HooksCreateParameters setMeetingID(string $id)
* @method $this setMeetingID(string $id)
* @method bool|null isGetRaw()
* @method HooksCreateParameters setGetRaw(bool $getRaw)
* @method $this setGetRaw(bool $getRaw)
*/
class HooksCreateParameters extends BaseParameters
{
Expand Down
2 changes: 1 addition & 1 deletion src/Parameters/HooksDestroyParameters.php
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

/**
* @method string getHookID()
* @method HooksDestroyParameters setHookID(string $hookID)
* @method $this setHookID(string $hookID)
*/
class HooksDestroyParameters extends BaseParameters
{
Expand Down
2 changes: 1 addition & 1 deletion src/Parameters/IsMeetingRunningParameters.php
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
* Class IsMeetingRunningParameters
*
* @method string getMeetingID()
* @method IsMeetingRunningParameters setMeetingID(string $id)
* @method $this setMeetingID(string $id)
*/
class IsMeetingRunningParameters extends BaseParameters
{
Expand Down
24 changes: 12 additions & 12 deletions src/Parameters/JoinMeetingParameters.php
Original file line number Diff line number Diff line change
Expand Up @@ -24,29 +24,29 @@
* @method string getFullName()
* @method $this setFullName(string $fullName)
* @method string getMeetingID()
* @method JoinMeetingParameters setMeetingID(string $id)
* @method $this setMeetingID(string $id)
* @method string getPassword()
* @method JoinMeetingParameters setPassword(string $password)
* @method $this setPassword(string $password)
* @method string getCreateTime()
* @method JoinMeetingParameters setCreateTime(string $createTime)
* @method $this setCreateTime(string $createTime)
* @method string getUserID()
* @method JoinMeetingParameters setUserID(string $userID)
* @method $this setUserID(string $userID)
* @method string getWebVoiceConf()
* @method JoinMeetingParameters setWebVoiceConf(string $webVoiceConf)
* @method $this setWebVoiceConf(string $webVoiceConf)
* @method string getConfigToken()
* @method JoinMeetingParameters setConfigToken(string $configToken)
* @method $this setConfigToken(string $configToken)
* @method string getDefaultLayout()
* @method JoinMeetingParameters setDefaultLayout(string $defaultLayout)
* @method $this setDefaultLayout(string $defaultLayout)
* @method string getAvatarURL()
* @method JoinMeetingParameters setAvatarURL(string $avatarURL)
* @method $this setAvatarURL(string $avatarURL)
* @method bool|null isRedirect()
* @method CreateMeetingParameters setRedirect(bool $redirect)
* @method $this setRedirect(bool $redirect)
* @method string getClientURL()
* @method JoinMeetingParameters setClientURL(string $clientURL)
* @method $this setClientURL(string $clientURL)
* @method bool|null isJoinViaHtml5()
* @method CreateMeetingParameters setJoinViaHtml(bool $joinViaHtml)
* @method $this setJoinViaHtml(bool $joinViaHtml)
* @method bool|null isGuest()
* @method CreateMeetingParameters setGuest(bool $guest)
* @method $this setGuest(bool $guest)
*/
class JoinMeetingParameters extends UserDataParameters
{
Expand Down
4 changes: 2 additions & 2 deletions src/Parameters/PublishRecordingsParameters.php
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@
* Class PublishRecordingsParameters
*
* @method string getRecordID()
* @method PublishRecordingsParameters setRecordID(string $recordID)
* @method $this setRecordID(string $recordID)
* @method bool|null isPublish()
* @method PublishRecordingsParameters setPublish(bool $publish)
* @method $this setPublish(bool $publish)
*/
class PublishRecordingsParameters extends BaseParameters
{
Expand Down
12 changes: 6 additions & 6 deletions src/Parameters/PutRecordingTextTrackParameters.php
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,17 @@
* Class GetRecordingTextTracksParameters
*
* @method string getRecordID()
* @method PutRecordingTextTrackParameters setRecordID(string $recordID)
* @method $this setRecordID(string $recordID)
* @method string getKind()
* @method PutRecordingTextTrackParameters setKind(string $kind)
* @method $this setKind(string $kind)
* @method string getLang()
* @method PutRecordingTextTrackParameters setLang(string $lang)
* @method $this setLang(string $lang)
* @method string getLabel()
* @method PutRecordingTextTrackParameters setLabel(string $label)
* @method $this setLabel(string $label)
* @method string getContentType()
* @method PutRecordingTextTrackParameters set(string $contentType)
* @method $this set(string $contentType)
* @method mixed getFile()
* @method PutRecordingTextTrackParameters setFile(mixed $file)
* @method $this setFile(mixed $file)
*/
class PutRecordingTextTrackParameters extends BaseParameters
{
Expand Down
4 changes: 2 additions & 2 deletions src/Parameters/SetConfigXMLParameters.php
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@
* Class SetConfigXMLParameters
*
* @method string getMeetingID()
* @method SetConfigXMLParameters setMeetingID(string $id)
* @method $this setMeetingID(string $id)
* @method \SimpleXMLElement getRawXml()
* @method SetConfigXMLParameters setRawXml(\SimpleXMLElement $rawXml)
* @method $this setRawXml(\SimpleXMLElement $rawXml)
*/
class SetConfigXMLParameters extends BaseParameters
{
Expand Down
2 changes: 1 addition & 1 deletion src/Parameters/UpdateRecordingsParameters.php
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
* Class UpdateRecordingsParameters
*
* @method string getRecordID()
* @method UpdateRecordingsParameters setRecordID(string $recordID)
* @method $this setRecordID(string $recordID)
*/
class UpdateRecordingsParameters extends MetaParameters
{
Expand Down

0 comments on commit c0f1cc4

Please sign in to comment.