Class FamilyTreeRelationshipState

The FamilyTreeRelationshipState exposes management and other FamilySearch specific functions for a relationship.

Gedcomx\Rs\Client\GedcomxApplicationState

Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreeRelationshipState implements Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\PreferredRelationshipState

Namespace: Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree
Package: Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree
Located at Extensions/FamilySearch/Rs/Client/FamilyTree/FamilyTreeRelationshipState.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 fmaily tree relationship state using the specified client, request, response, access token, and state factory. Constructs a new fmaily tree relationship state using the specified client, request, response, access token, and state factory. Parameters `$client` `$request` `$response` `$accessToken` `$stateFactory` Overrides `Gedcomx\Rs\Client\RelationshipState::__construct`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreeRelationshipState`	# `loadDiscussionReferences( Gedcomx\Rs\Client\Options\StateTransitionOption $options = null )` Loads all discussion references for the current relationship. Loads all discussion references for the current relationship. Parameters `$options` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreeRelationshipState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChangeHistoryState\|null`	# `readChangeHistory( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Reads the change history of the current relationship. Reads the change history of the current relationship. Parameters `$option` ,.. Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChangeHistoryState`\|null
`public mixed\|null`	# `restore( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Restore the current relationship (if it is currently deleted). Restore the current relationship (if it is currently deleted). Parameters `$option` Returns mixed\|null

Methods inherited from Gedcomx\Rs\Client\RelationshipState

addEvidenceReference(), addEvidenceReferenceState(), addEvidenceReferences(), addFact(), addFacts(), addMediaReference(), addMediaReferenceState(), addMediaReferences(), addNote(), addNotes(), addSourceDescriptionState(), addSourceReference(), addSourceReferences(), deleteEvidenceReference(), deleteFact(), deleteMediaReference(), deleteNote(), deleteSourceReference(), getNote(), getRelationship(), getSelfRel(), getSourceReference(), loadConclusions(), loadEmbeddedResources(), loadEvidenceReferences(), loadMediaReferences(), loadNotes(), loadSourceReferences(), readNote(), readSources(), updateEvidenceReference(), updateEvidenceReferences(), updateFact(), updateFacts(), updateMediaReference(), updateMediaReferences(), updateNote(), updateNotes(), updateRelationshipNotes(), updateSelf(), updateSourceReference(), updateSourceReferences()

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(), getSelfUri(), getStatus(), getUri(), hasClientError(), hasError(), hasServerError(), hasStatus(), head(), ifSuccessful(), inject(), isAuthenticated(), loadAllEmbeddedResources(), logout(), options(), post(), put(), readAttributableContributor(), readContributor(), readReferenceContributor(), send()

Namespaces

Classes

Interfaces

Class FamilyTreeRelationshipState

Methods summary

Parameters

Overrides

Parameters

Returns

Parameters

Returns

Parameters

Returns

Methods inherited from Gedcomx\Rs\Client\RelationshipState

Methods inherited from Gedcomx\Rs\Client\GedcomxApplicationState