Connection_Status

Constants

Constant	Visibility	Type	Value
`STATUS_CACHE`	public		’bigcommerce_connection_status’
`STATUS_CACHE_TTL`	public		60

Connection_Status constructor.

public __construct(\BigCommerce\Api\v3\Api\CatalogApi $client, bool $configuration_status): mixed

Parameters:

Parameter	Type	Description
`$client`	\BigCommerce\Api\v3\Api\CatalogApi
`$configuration_status`	bool	Whether API configuration settings are fully in place

public register_field(): mixed

public render_status(): mixed

Display a notice if all required credentials are not set.

public credentials_required_notice(\BigCommerce\Settings\Screens\Abstract_Screen $target_screen, string[] $excluded_screens = []): void

Parameters:

Parameter	Type	Description
`$target_screen`	\BigCommerce\Settings\Screens\Abstract_Screen	Settings screen the link will point to
`$excluded_screens`	string[]	Settings screen IDs that should not show the notice

public flush_status_cache(): void

Automatically generated on 2025-01-21