Class FamilyTreeCollectionState

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

Class FamilySearchCollectionState

Gedcomx\Rs\Client\GedcomxApplicationState

Extended by

Gedcomx\Rs\Client\CollectionState

Extended by

Gedcomx\Extensions\FamilySearch\Rs\Client\FamilySearchCollectionState

Extended by

Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreeCollectionState

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

Methods summary

`public`	# `__construct( GuzzleHttp\Client $client, GuzzleHttp\Psr7\Request $request, GuzzleHttp\Psr7\Response $response, string $accessToken, Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreeStateFactory $stateFactory )` Create a new FamilyTreeCollectionState object Create a new FamilyTreeCollectionState object Parameters `$client` `$request` `$response` `$accessToken` `$stateFactory` Overrides `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilySearchCollectionState::__construct`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreeCollectionState`	# `authenticateViaUnauthenticatedAccess( string $clientId, string $ipAddress )` Begin and unauthenticated session Begin and unauthenticated session Parameters `$clientId` `$ipAddress` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreeCollectionState`
`public Gedcomx\Rs\Client\RelationshipState\|null`	# `addRelationship( Gedcomx\Conclusion\Relationship $relationship, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Add a new relationship to the collection Add a new relationship to the collection Parameters `$relationship` `$option` Returns `Gedcomx\Rs\Client\RelationshipState`\|null Throws `Gedcomx\Rs\Client\Exception\GedcomxApplicationException` Overrides `Gedcomx\Rs\Client\CollectionState::addRelationship`
`public Gedcomx\Rs\Client\RelationshipState`	# `addRelationships( array $relationships, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Add a list of relationships to the collection Add a list of relationships to the collection Parameters `$relationships` `$option` Returns `Gedcomx\Rs\Client\RelationshipState` Throws `Gedcomx\Rs\Client\Exception\GedcomxApplicationException` Overrides `Gedcomx\Rs\Client\CollectionState::addRelationships`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`	# `addChildAndParents( Gedcomx\Rs\Client\PersonState $child, Gedcomx\Rs\Client\PersonState $father = null, Gedcomx\Rs\Client\PersonState $mother = null, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Add a relationship by defining the child and parents Add a relationship by defining the child and parents Parameters `$child` `$father` `$mother` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`	# `addChildAndParentsRelationship( Gedcomx\Extensions\FamilySearch\Platform\Tree\ChildAndParentsRelationship $rel, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Add a ChildAndParentsRelationship to the collection Add a ChildAndParentsRelationship to the collection Parameters `$rel` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState` Throws `Gedcomx\Rs\Client\Exception\GedcomxApplicationException`
`public Gedcomx\Rs\Client\RelationshipsState`	# `addChildAndParentsRelationships( array $chaps, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Add a list of ChildAndParentsRelationships to the collection Add a list of ChildAndParentsRelationships to the collection Parameters `$chaps` `$option` Returns `Gedcomx\Rs\Client\RelationshipsState` Throws `Gedcomx\Rs\Client\Exception\GedcomxApplicationException`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreeCollectionState`	# `readDiscoveryDocument( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Read the discovery document for this collection Read the discovery document for this collection Parameters `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreeCollectionState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreePersonState\|null`	# `readPersonById( string $id, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Read a person with a given id Read a person with a given id Parameters `$id` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreePersonState`\|null
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreePersonState`	# `readPersonWithRelationshipsById( string $id, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Read a person and their relationships by the person's id Read a person and their relationships by the person's id Parameters `$id` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreePersonState` Throws `Gedcomx\Rs\Client\Exception\GedcomxApplicationException`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\PreferredRelationshipState`	# `readPreferredSpouseRelationship( string $treeUserId, string $personId, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Read the preferred spouse relationship on a person Read the preferred spouse relationship on a person Parameters `$treeUserId` `$personId` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\PreferredRelationshipState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\PreferredRelationshipState`	# `readPreferredParentRelationship( string $treeUserId, string $personId, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Read the preferred parent relationship for a person Read the preferred parent relationship for a person Parameters `$treeUserId` `$personId` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\PreferredRelationshipState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreePersonState`	# `updatePreferredSpouseRelationship( string $treeUserId, string $personId, Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\PreferredRelationshipState $relationshipState, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Update the preferred spouse relationship for a person Update the preferred spouse relationship for a person Parameters `$treeUserId` `$personId` `$relationshipState` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreePersonState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreePersonState`	# `updatePreferredParentRelationship( string $treeUserId, string $personId, Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\PreferredRelationshipState $relationshipState, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Update the preferred parent relationship for a person Update the preferred parent relationship for a person Parameters `$treeUserId` `$personId` `$relationshipState` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreePersonState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreePersonState`	# `deletePreferredSpouseRelationship( string $treeUserId, string $personId, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Remove the preferred spouse relationship from a person Remove the preferred spouse relationship from a person Parameters `$treeUserId` `$personId` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreePersonState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreePersonState`	# `deletePreferredParentRelationship( string $treeUserId, string $personId, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Remove the preferred parent relationship for a person Remove the preferred parent relationship for a person Parameters `$treeUserId` `$personId` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreePersonState`

Methods inherited from Gedcomx\Extensions\FamilySearch\Rs\Client\FamilySearchCollectionState

addDiscussion(), addProcessingTime(), getCollection(), normalizeDate(), readCurrentUser(), readCurrentUserHistory(), readDiscussions(), readPerson(), searchForPersonMatches()

Methods inherited from Gedcomx\Rs\Client\CollectionState

AddParentChildRelationship(), addArtifact(), addCollection(), addPerson(), addRecord(), 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()