Class DiscussionState

The DiscussionState exposes management functions for a discussion.

Gedcomx\Rs\Client\GedcomxApplicationState

Gedcomx\Extensions\FamilySearch\Rs\Client\DiscussionState

Namespace: Gedcomx\Extensions\FamilySearch\Rs\Client
Package: Gedcomx\Extensions\FamilySearch\Rs\Client
Located at Extensions/FamilySearch/Rs/Client/DiscussionState.php

Methods summary

`public`	# `__construct( GuzzleHttp\Client $client, GuzzleHttp\Psr7\Request $request, GuzzleHttp\Psr7\Response $response, string $accessToken, Gedcomx\Extensions\FamilySearch\Rs\Client\FamilySearchStateFactory $stateFactory )` Constructs a new discussion state using the specified client, request, response, access token, and state factory. Constructs a new discussion state using the specified client, request, response, access token, and state factory. Parameters `$client` `$request` `$response` `$accessToken` `$stateFactory` Overrides `Gedcomx\Rs\Client\GedcomxApplicationState::__construct`
`public Gedcomx\Extensions\FamilySearch\Platform\Discussions\Discussion`	# `getDiscussion( )` Gets the first discussion from the current entity (FamilySearchPlatform::getDiscussions()). Gets the first discussion from the current entity (FamilySearchPlatform::getDiscussions()). Returns `Gedcomx\Extensions\FamilySearch\Platform\Discussions\Discussion`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\DiscussionState`	# `loadComments( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Loads the comments for the current discussion. Loads the comments for the current discussion. Parameters `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\DiscussionState`
`public mixed`	# `update( Gedcomx\Extensions\FamilySearch\Platform\Discussions\Discussion $discussion, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Updates the specified discussion. Updates the specified discussion. Parameters `$discussion` `$option` Returns mixed
`public Gedcomx\Extensions\FamilySearch\Rs\Client\DiscussionState`	# `addCommentString( String $comment, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Adds a comment to the current discussion. Adds a comment to the current discussion. Parameters `$comment` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\DiscussionState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\DiscussionState`	# `addComment( Gedcomx\Extensions\FamilySearch\Platform\Discussions\Comment $comment, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Adds a comment to the current discussion. Adds a comment to the current discussion. Parameters `$comment` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\DiscussionState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\DiscussionState`	# `addComments( array $comments, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Adds the specified comments to the current discussion. Adds the specified comments to the current discussion. Parameters `$comments` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\DiscussionState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\DiscussionState`	# `updateComment( Gedcomx\Extensions\FamilySearch\Platform\Discussions\Comment $comment, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Updates the specified comment on the current discussion. Updates the specified comment on the current discussion. Parameters `$comment` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\DiscussionState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\DiscussionState`	# `updateComments( array $comments, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Updates the specified comments on the current discussion. Updates the specified comments on the current discussion. Parameters `$comments` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\DiscussionState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\DiscussionState`	# `deleteComment( Gedcomx\Extensions\FamilySearch\Platform\Discussions\Comment $comment, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Deletes the specified comment from the current discussion. Deletes the specified comment from the current discussion. Parameters `$comment` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\DiscussionState` Throws `Gedcomx\Rs\Client\Exception\GedcomxApplicationException`

Methods inherited from Gedcomx\Rs\Client\GedcomxApplicationState

authenticateViaOAuth2AuthCode(), authenticateViaOAuth2ClientCredentials(), authenticateViaOAuth2Password(), authenticateViaOAuth2WithoutCredentials(), authenticateWithAccessToken(), delete(), generateClientSecret(), get(), getAccessToken(), getClient(), getETag(), getEntity(), getHeader(), getHeaders(), getLastEmbeddedRequest(), getLastEmbeddedResponse(), getLastModified(), getLink(), getLinks(), getRequest(), getResourceReference(), getResponse(), getSelfRel(), getSelfUri(), getStatus(), getUri(), hasClientError(), hasError(), hasServerError(), hasStatus(), head(), ifSuccessful(), inject(), isAuthenticated(), loadAllEmbeddedResources(), logout(), options(), post(), put(), readAttributableContributor(), readContributor(), readReferenceContributor(), send()

Namespaces

Classes

Class DiscussionState

Methods summary

Parameters

Overrides

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Methods inherited from Gedcomx\Rs\Client\GedcomxApplicationState