Class ChildAndParentsRelationshipState

Gedcomx\Rs\Client\GedcomxApplicationState

Gedcomx\Extensions\FamilySearch\Rs\Client\FamilySearchCollectionState

Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState 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/ChildAndParentsRelationshipState.php

Methods summary

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

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

Methods inherited from Gedcomx\Rs\Client\CollectionState

AddParentChildRelationship(), addArtifact(), addCollection(), addPerson(), addRecord(), addRelationship(), addRelationships(), addSourceDescription(), addSpouseRelationship(), 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(), getSelfUri(), getStatus(), getUri(), hasClientError(), hasError(), hasServerError(), hasStatus(), head(), ifSuccessful(), inject(), isAuthenticated(), loadAllEmbeddedResources(), logout(), options(), post(), put(), readAttributableContributor(), readContributor(), readReferenceContributor(), send()

`public string`	# `getSelfRel( )` Define the rel for this state as a fallback if it cannot be determined from the state data Define the rel for this state as a fallback if it cannot be determined from the state data Returns string Overrides `Gedcomx\Rs\Client\GedcomxApplicationState::getSelfRel`
`public Gedcomx\Extensions\FamilySearch\Platform\Tree\ChildAndParentsRelationship\|null`	# `getRelationship( )` Returns the relationship object represented by this state, if any Returns the relationship object represented by this state, if any Returns `Gedcomx\Extensions\FamilySearch\Platform\Tree\ChildAndParentsRelationship`\|null
`public Gedcomx\Conclusion\Conclusion`	# `getConclusion( )` Gets the first conclusion for this relationship. FatherFact is returned first if it is not null; otherwise, MotherFact is returned. Gets the first conclusion for this relationship. FatherFact is returned first if it is not null; otherwise, MotherFact is returned. Returns `Gedcomx\Conclusion\Conclusion`
`public Gedcomx\Conclusion\Fact\|null`	# `getFatherFact( )` Return the first fact associated with the father Return the first fact associated with the father Returns `Gedcomx\Conclusion\Fact`\|null
`public Gedcomx\Conclusion\Fact\|null`	# `getMotherFact( )` Return the first fact associated with the mother Return the first fact associated with the mother Returns `Gedcomx\Conclusion\Fact`\|null
`public Gedcomx\Common\Note\|null`	# `getNote( )` Gets the first Note from the current Relationship. Gets the first Note from the current Relationship. Returns `Gedcomx\Common\Note`\|null
`public Gedcomx\Source\SourceReference\|null`	# `getSourceReference( )` Return the first source reference for this relationship Return the first source reference for this relationship Returns `Gedcomx\Source\SourceReference`\|null
`public Gedcomx\Common\EvidenceReference\|null`	# `getEvidenceReference( )` Return the first evidence reference for this relationship Return the first evidence reference for this relationship Returns `Gedcomx\Common\EvidenceReference`\|null
`public Gedcomx\Source\SourceReference\|null`	# `getMediaReference( )` Return the first media reference for this relationship Return the first media reference for this relationship Returns `Gedcomx\Source\SourceReference`\|null
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreeCollectionState\|null`	# `readCollection( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Get a copy of this object's collection state Get a copy of this object's collection state Parameters `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreeCollectionState`\|null Overrides `Gedcomx\Rs\Client\CollectionState::readCollection`
`public`	# `loadEmbeddedResource( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Load an embedded resource for this relationship Load an embedded resource for this relationship Parameters `$option` Returns $this
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState\|null`	# `loadEmbeddedResources( array $rels, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Load the embedded resources for this relationship Load the embedded resources for this relationship Parameters `$rels` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`\|null
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`	# `loadConclusions( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Load conclusion data for this relationship Load conclusion data for this relationship Parameters `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`	# `loadSourceReferences( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Load source references for this relationship Load source references for this relationship Parameters `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`	# `loadMediaReferences( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Load media references for this relationship Load media references for this relationship Parameters `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`	# `loadEvidenceReferences( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Load evidence references for this relationship Load evidence references for this relationship Parameters `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`	# `loadNotes( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Load the notes for this relationship Load the notes for this relationship Parameters `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`	# `addFatherFact( Gedcomx\Conclusion\Fact $fact, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Add a fact to the father in this relationship Add a fact to the father in this relationship Parameters `$fact` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`	# `addFatherFacts( array $facts, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Add a list of facts to the father in this relationship Add a list of facts to the father in this relationship Parameters `$facts` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`	# `updateFatherFact( Gedcomx\Conclusion\Fact $fact, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Update the specified father fact on the current relationship. Update the specified father fact on the current relationship. Parameters `$fact` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`	# `updateFatherFacts( array $facts, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Update a list of facts on the father. Update a list of facts on the father. Parameters `$facts` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`	# `addMotherFact( Gedcomx\Conclusion\Fact $fact, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Add a fact to the mother in this relationship Add a fact to the mother in this relationship Parameters `$fact` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`	# `addMotherFacts( array $facts, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Add a list of facts to the mother in this relationship Add a list of facts to the mother in this relationship Parameters `$facts` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`	# `updateMotherFact( Gedcomx\Conclusion\Fact $fact, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Update a fact on the mother in this relationship Update a fact on the mother in this relationship Parameters `$fact` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`	# `updateMotherFacts( array $facts, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Update a list of facts on the mother in this relationship Update a list of facts on the mother in this relationship Parameters `$facts` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`	# `deleteFact( Gedcomx\Conclusion\Fact $fact, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Delete a fact from this relationship Delete a fact from this relationship Parameters `$fact` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState` Throws `Gedcomx\Rs\Client\Exception\GedcomxApplicationException`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`	# `addSourceReferenceState( Gedcomx\Rs\Client\SourceDescriptionState $source, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Add a source reference to this relationship using a state object Add a source reference to this relationship using a state object Parameters `$source` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`	# `addSourceReference( Gedcomx\Source\SourceReference $reference, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Add a source reference to this relationship using a SourceReference object Add a source reference to this relationship using a SourceReference object Parameters `$reference` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`	# `addSourceReferences( array $refs, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Add a list of source references to this relationship Add a list of source references to this relationship Parameters `$refs` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`	# `updateSourceReference( Gedcomx\Source\SourceReference $reference, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Update a source reference on this relationship Update a source reference on this relationship Parameters `$reference` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`	# `updateSourceReferences( array $refs, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Update a list of source references on this relationship Update a list of source references on this relationship Parameters `$refs` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`	# `deleteSourceReference( Gedcomx\Source\SourceReference $reference, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Delete a source reference from this relationship Delete a source reference from this relationship Parameters `$reference` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState` Throws `Gedcomx\Rs\Client\Exception\GedcomxApplicationException`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`	# `addMediaReference( Gedcomx\Source\SourceReference $reference, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Add a media reference to this relationship Add a media reference to this relationship Parameters `$reference` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`	# `addMediaReferences( array $refs, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Add a list of media references to this relationship Add a list of media references to this relationship Parameters `$refs` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`	# `updateMediaReference( Gedcomx\Source\SourceReference $reference, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Update a media reference on this relationship Update a media reference on this relationship Parameters `$reference` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`	# `updateMediaReferences( array $refs, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Update a list of media references for this relationship Update a list of media references for this relationship Parameters `$refs` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`	# `deleteMediaReference( Gedcomx\Source\SourceReference $reference, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Delete a media reference from this relationship Delete a media reference from this relationship Parameters `$reference` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState` Throws `Gedcomx\Rs\Client\Exception\GedcomxApplicationException`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`	# `addEvidenceReference( Gedcomx\Common\EvidenceReference $reference, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` And an evidence reference to this relationship And an evidence reference to this relationship Parameters `$reference` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`	# `addEvidenceReferences( array $refs, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Add a list of evidence references to this relationship Add a list of evidence references to this relationship Parameters `$refs` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`	# `updateEvidenceReference( Gedcomx\Common\EvidenceReference $reference, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Update an evidence reference on this relationship Update an evidence reference on this relationship Parameters `$reference` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`

Namespaces

Classes

Interfaces

Class ChildAndParentsRelationshipState

Methods summary

Returns

Overrides

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Overrides

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Parameters