Class FamilySearchSourceDescriptionState

The FamilySearchSourceDescriptionState exposes management functions for a FamilySearch source description.

Gedcomx\Extensions\FamilySearch\Rs\Client\FamilySearchSourceDescriptionState

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

Methods summary

`public`	# `__construct( GuzzleHttp\Client $client, GuzzleHttp\Psr7\Request $request, GuzzleHttp\Psr7\Response $response, string $accessToken, Gedcomx\Rs\Client\StateFactory $stateFactory )` Constructs a new FamilySearch source description state using the specified client, request, response, access token, and state factory. Constructs a new FamilySearch source description state using the specified client, request, response, access token, and state factory. Parameters `$client` `$request` `$response` `$accessToken` `$stateFactory` Overrides `Gedcomx\Rs\Client\SourceDescriptionState::__construct`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\DiscussionState\|null`	# `readComments( Gedcomx\Rs\Client\Options\StateTransitionOption $options = null )` Reads the comments on the current source description. Reads the comments on the current source description. Parameters `$options` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\DiscussionState`\|null
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilySearchSourceDescriptionState\|null`	# `moveToCollection( Gedcomx\Rs\Client\CollectionState $collection, Gedcomx\Rs\Client\Options\StateTransitionOption $options = null )` Moves the current source description to the specified collection. Moves the current source description to the specified collection. Parameters `$collection` `$options` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilySearchSourceDescriptionState`\|null

`public`	# `__construct( GuzzleHttp\Client $client, GuzzleHttp\Psr7\Request $request, GuzzleHttp\Psr7\Response $response, string $accessToken, Gedcomx\Rs\Client\StateFactory $stateFactory )` Constructs a new FamilySearch source description state using the specified client, request, response, access token, and state factory. Constructs a new FamilySearch source description state using the specified client, request, response, access token, and state factory. Parameters `$client` `$request` `$response` `$accessToken` `$stateFactory` Overrides `Gedcomx\Rs\Client\SourceDescriptionState::__construct`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\DiscussionState\|null`	# `readComments( Gedcomx\Rs\Client\Options\StateTransitionOption $options = null )` Reads the comments on the current source description. Reads the comments on the current source description. Parameters `$options` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\DiscussionState`\|null
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilySearchSourceDescriptionState\|null`	# `moveToCollection( Gedcomx\Rs\Client\CollectionState $collection, Gedcomx\Rs\Client\Options\StateTransitionOption $options = null )` Moves the current source description to the specified collection. Moves the current source description to the specified collection. Parameters `$collection` `$options` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilySearchSourceDescriptionState`\|null