Class AncestryResultsState

The AncestryResultsState exposes management functions for ancestry results.

Gedcomx\Rs\Client\AncestryResultsState

Namespace: Gedcomx\Rs\Client
Package: Gedcomx\Rs\Client
Located at Rs/Client/AncestryResultsState.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 ancestry results state using the specified client, request, response, access token, and state factory. Constructs a new ancestry results state using the specified client, request, response, access token, and state factory. Parameters `$client` `$request` `$response` `$accessToken` `$stateFactory` Overrides `Gedcomx\Rs\Client\GedcomxApplicationState::__construct`
`public string`	# `getSelfRel( )` Gets the rel name for the current state instance. Gets the rel name for the current state instance. Returns string Overrides `Gedcomx\Rs\Client\GedcomxApplicationState::getSelfRel`
`public Gedcomx\Rs\Client\Util\AncestryTree`	# `getTree( )` Gets the tree represented by the REST API response. Gets the tree represented by the REST API response. Returns `Gedcomx\Rs\Client\Util\AncestryTree`
`public mixed\|null`	# `readPerson( $ancestorNumber, Gedcomx\Gedcomx\Rs\Client\StateTransitionOption $option = null )` Reads the person at the specified one-based index number. Reads the person at the specified one-based index number. Parameters `$ancestorNumber` `$option` Returns mixed\|null