Class FamilySearchCollectionState

The FamilySearchCollectionState is a collection of FamilySearch resources and exposes management of those resources.

Gedcomx\Rs\Client\GedcomxApplicationState

Gedcomx\Extensions\FamilySearch\Rs\Client\FamilySearchCollectionState

Direct known subclasses

Gedcomx\Extensions\FamilySearch\Rs\Client\FamilySearchPlaces, Gedcomx\Extensions\FamilySearch\Rs\Client\FamilySearchPlaceState, Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState, Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreeCollectionState, Gedcomx\Extensions\FamilySearch\Rs\Client\Memories\FamilySearchMemories, Gedcomx\Extensions\FamilySearch\Rs\Client\PersonMergeState, Gedcomx\Extensions\FamilySearch\Rs\Client\UserHistoryState, Gedcomx\Extensions\FamilySearch\Rs\Client\UserState

Namespace: Gedcomx\Extensions\FamilySearch\Rs\Client
Package: Gedcomx\Extensions\FamilySearch\Rs\Client
Located at Extensions/FamilySearch/Rs/Client/FamilySearchCollectionState.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 FamilySearch collection state using the specified client, request, response, access token, and state factory. Constructs a new FamilySearch collection state using the specified client, request, response, access token, and state factory. Parameters `$client` `$request` `$response` `$accessToken` `$stateFactory` Overrides `Gedcomx\Rs\Client\CollectionState::__construct`
`public null`	# `getCollection( )` Gets the first collection from $this->entity->getCollections(). Gets the first collection from $this->entity->getCollections(). Returns null Overrides `Gedcomx\Rs\Client\CollectionState::getCollection`
`public Gedcomx\Conclusion\DateInfo\|null`	# `normalizeDate( string $date, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Normalizes the specified date to a DateInfo. Normalizes the specified date to a DateInfo. Parameters `$date` `$option` Returns `Gedcomx\Conclusion\DateInfo`\|null
`public`	# `readPerson( string $uri, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Reads the person specified by the URI. Reads the person specified by the URI. Parameters `$uri` href from a Link object `$option` Returns \Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreePersonState\|null Overrides `Gedcomx\Rs\Client\CollectionState::readPerson`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\UserState\|null`	# `readCurrentUser( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Reads the current tree user data. Reads the current tree user data. Parameters `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\UserState`\|null
`public Gedcomx\Extensions\FamilySearch\Rs\Client\UserHistoryState\|null`	# `readCurrentUserHistory( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Reads the current user's history. Reads the current user's history. Parameters `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\UserHistoryState`\|null
`public Gedcomx\Extensions\FamilySearch\Rs\Client\PersonMatchResultsState`	# `searchForPersonMatches( Gedcomx\Rs\Client\Util\GedcomxPersonSearchQueryBuilder\|string $query, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Searches for person matches based off the specified query. Searches for person matches based off the specified query. Parameters `$query` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\PersonMatchResultsState`
`public Gedcomx\Extensions\FamilySearch\Platform\Discussions\Discussion\|null`	# `readDiscussions( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Reads the discussions on the current collection. Reads the discussions on the current collection. Parameters `$option` Returns `Gedcomx\Extensions\FamilySearch\Platform\Discussions\Discussion`\|null
`public Gedcomx\Extensions\FamilySearch\Rs\Client\DiscussionState`	# `addDiscussion( Gedcomx\Extensions\FamilySearch\Platform\Discussions\Discussion $discussion, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Adds a discussion to the current collection. Adds a discussion to the current collection. Parameters `$discussion` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\DiscussionState` Throws `Gedcomx\Rs\Client\Exception\GedcomxApplicationException`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilySearchCollectionState`	# `addProcessingTime( integer $time, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Adds processing time for the current user. Useful for testing throttling. Adds processing time for the current user. Useful for testing throttling. Parameters `$time` Additional time in milliseconds `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilySearchCollectionState`

Methods inherited from Gedcomx\Rs\Client\CollectionState

AddParentChildRelationship(), addArtifact(), addCollection(), addPerson(), addRecord(), addRelationship(), addRelationships(), addSourceDescription(), addSpouseRelationship(), readCollection(), readPersonForCurrentUser(), readPersons(), readRecords(), readRelationships(), readResourcesOfCurrentUser(), readSourceDescriptions(), readSubcollections(), searchForPersons(), update()

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 FamilySearchCollectionState

Direct known subclasses

Methods summary

Parameters

Overrides

Returns

Overrides

Parameters

Returns

Parameters

Returns

Overrides

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Methods inherited from Gedcomx\Rs\Client\CollectionState

Methods inherited from Gedcomx\Rs\Client\GedcomxApplicationState