TectlyClient
in package
Table of Contents
Properties
- $documentPagesApi : DocumentPagesApi
- $documentsApi : DocumentsApi
- $floorsApi : FloorsApi
- $plansApi : PlansApi
- $projectsApi : ProjectsApi
- $roomsApi : RoomsApi
- $wallOpeningsApi : WallOpeningsApi
- $wallsApi : WallsApi
- $config : Configuration
Methods
- __construct() : mixed
- Creates a new authenticated TectlyClient instance from the provided API credentials.
- awaitDocument() : Document
- Wait for a document's page rendering to complete (blocking).
- awaitDocumentPage() : DocumentPage
- Wait for a document page's plan detection to complete (blocking).
- awaitPlan() : Plan
- Wait for a plan to complete processing (blocking).
- fetchFloorElements() : array<string|int, mixed>
- Fetch all floor elements (rooms, walls and wall openings) for a given floor ID.
- getConfiguration() : Configuration
- Get the default configuration for the Tectly API client.
- isDocumentPageProcessed() : bool
- Returns true if a document page has completed plan detection, false if still processing.
- isDocumentProcessed() : bool
- Returns true if a document has completed page rendering, false if still processing.
- isPlanProcessed() : bool
- Returns true if a plan has completed processing, false if still processing.
- authenticate() : string
Properties
$documentPagesApi
public
DocumentPagesApi
$documentPagesApi
API client for managing document pages
$documentsApi
public
DocumentsApi
$documentsApi
API client for managing documents
$floorsApi
public
FloorsApi
$floorsApi
API client for managing floors
$plansApi
public
PlansApi
$plansApi
API client for managing plans
$projectsApi
public
ProjectsApi
$projectsApi
API client for managing projects
$roomsApi
public
RoomsApi
$roomsApi
API client for managing rooms
$wallOpeningsApi
public
WallOpeningsApi
$wallOpeningsApi
API client for managing wall openings (doors, windows)
$wallsApi
public
WallsApi
$wallsApi
API client for managing walls
$config
private
Configuration
$config
Methods
__construct()
Creates a new authenticated TectlyClient instance from the provided API credentials.
public
__construct(string $apiKey, string $apiSecret) : mixed
Parameters
- $apiKey : string
-
The API key for authentication
- $apiSecret : string
-
The API secret for authentication
awaitDocument()
Wait for a document's page rendering to complete (blocking).
public
awaitDocument(string $documentId) : Document
This method blocks execution until the document's page rendering is complete.
Parameters
- $documentId : string
-
The ID of the document to wait for
Return values
Document —The document with completed page rendering
awaitDocumentPage()
Wait for a document page's plan detection to complete (blocking).
public
awaitDocumentPage(string $pageId) : DocumentPage
This method blocks execution until plan detection on the page is complete.
Parameters
- $pageId : string
-
The ID of the document page to wait for
Return values
DocumentPage —The page with completed plan detection
awaitPlan()
Wait for a plan to complete processing (blocking).
public
awaitPlan(string $planId) : Plan
This method blocks execution until all processing stages are complete.
Parameters
- $planId : string
-
The ID of the plan to wait for
Return values
Plan —The fully processed plan
fetchFloorElements()
Fetch all floor elements (rooms, walls and wall openings) for a given floor ID.
public
fetchFloorElements(string $floorId) : array<string|int, mixed>
Parameters
- $floorId : string
-
The ID of the floor to fetch elements for
Return values
array<string|int, mixed> —Associative array containing 'rooms', 'walls' and 'openings' arrays
getConfiguration()
Get the default configuration for the Tectly API client.
public
static getConfiguration() : Configuration
Return values
Configuration —The configured API client configuration
isDocumentPageProcessed()
Returns true if a document page has completed plan detection, false if still processing.
public
isDocumentPageProcessed(DocumentPage $page) : bool
Parameters
- $page : DocumentPage
-
The document page to check
Return values
bool —True if plan detection is complete, false otherwise
isDocumentProcessed()
Returns true if a document has completed page rendering, false if still processing.
public
isDocumentProcessed(Document $document) : bool
Parameters
- $document : Document
-
The document to check
Return values
bool —True if page rendering is complete, false otherwise
isPlanProcessed()
Returns true if a plan has completed processing, false if still processing.
public
isPlanProcessed(Plan $plan) : bool
Parameters
- $plan : Plan
-
The plan to check
Return values
bool —True if processing is complete, false otherwise
authenticate()
private
authenticate(string $username, string $password) : string
Parameters
- $username : string
- $password : string