Repository navigation
Referans SDK Control Plane
Cavanshirpro edited this page Sep 19, 2026
·
1 revision
English · Türkçe · Languages / Diller
Kapsam: JSON API Forge 0.5.1 · İnceleme: 17 Eylül 2026 · Dil: Türkçe
İmzalar kaynak dosyaların Python AST’sinden çıkarılmıştır; örnek olarak çalıştırılacak program değildir. self, sınıf instance’ı üzerinden çağrılırken ayrıca geçirilmez. * sonrasındaki argümanlar anahtar adıyla gönderilir. async def await edilir; dataclass alanları constructor parametrelerini de açıklar.
Control-plane SDK rehberi, HTTP endpointleri. _ControlPlaneBase altında listelenen public metotlar iki client tarafından devralınır.
Kaynak modül: json_api_forge/control_plane.py
@property
def has_session(self) -> bool: ...def set_session_token(self, token: str) -> None: ...def clear_session(self) -> None: ...def call_client_url(self, call_client_path: str, ticket: str) -> str: ...def __init__(self, base_url: str, *, timeout: float=15.0, max_response_bytes: int=8 * 1024 * 1024, max_attachment_bytes: int=_DEFAULT_ATTACHMENT_LIMIT, allow_insecure_http: bool=False, transport: httpx.BaseTransport | None=None): ...def setup_status(self) -> ForgeResponse[JsonObject]: ...def setup_founder(self, setup_token: str, username: str, password: str, display_name: str) -> ForgeResponse[JsonObject]: ...def login(self, username: str, password: str) -> ForgeResponse[JsonObject]: ...def register(self, invitation: str, username: str, password: str, display_name: str) -> ForgeResponse[JsonObject]: ...def logout(self) -> ForgeResponse[Any]: ...def capabilities(self) -> ForgeResponse[JsonObject]: ...def profile(self) -> ForgeResponse[JsonObject]: ...def update_profile(self, values: Mapping[str, str]) -> ForgeResponse[JsonObject]: ...def projects(self) -> ForgeResponse[JsonObject]: ...def create_project(self, name: str, slug: str) -> ForgeResponse[JsonObject]: ...def documents(self, project: str) -> ForgeResponse[JsonObject]: ...def document(self, project: str, document: str) -> ForgeResponse[JsonObject]: ...def save_document(self, project: str, document: str, content: str, expected_sha256: str) -> ForgeResponse[JsonObject]: ...def validate_project(self, project: str) -> ForgeResponse[JsonObject]: ...def roles(self) -> ForgeResponse[JsonObject]: ...def create_role(self, values: Mapping[str, Any]) -> ForgeResponse[JsonObject]: ...def update_role(self, role_id: str, values: Mapping[str, Any]) -> ForgeResponse[JsonObject]: ...def members(self) -> ForgeResponse[JsonObject]: ...def update_member(self, user_id: str, memberships: Sequence[Mapping[str, str]], *, active: bool=True) -> ForgeResponse[Any]: ...def create_invitation(self, memberships: Sequence[Mapping[str, str]], *, expires_hours: int=24) -> ForgeResponse[JsonObject]: ...def areas(self, project: str='*') -> ForgeResponse[JsonObject]: ...def create_area(self, values: Mapping[str, Any]) -> ForgeResponse[JsonObject]: ...def messages(self, area_id: str, *, limit: int=100) -> ForgeResponse[JsonObject]: ...def post_message(self, area_id: str, body: str, *, announcement: bool=False) -> ForgeResponse[JsonObject]: ...def notes(self, project: str='*') -> ForgeResponse[JsonObject]: ...def create_note(self, values: Mapping[str, Any]) -> ForgeResponse[JsonObject]: ...def database_catalog(self, project: str) -> ForgeResponse[JsonObject]: ...def database_rows(self, project: str, alias: str, table: str, *, limit: int=100, offset: int=0) -> ForgeResponse[JsonObject]: ...def attachments(self, area_id: str, *, limit: int=100) -> ForgeResponse[JsonObject]: ...def upload_attachment(self, area_id: str, source: str | os.PathLike[str]) -> ForgeResponse[JsonObject]: ...def download_attachment(self, attachment_id: str, target: str | os.PathLike[str]) -> ForgeResponse[Path]: ...def start_call(self, area_id: str, *, mode: str='video') -> ForgeResponse[JsonObject]: ...def call_ticket(self, call_id: str) -> ForgeResponse[JsonObject]: ...def audit(self, *, project: str | None=None, limit: int=100) -> ForgeResponse[JsonObject]: ...def close(self) -> None: ...def __enter__(self) -> EditorControlPlaneClient: ...def __exit__(self, *_args: Any) -> None: ...def __init__(self, base_url: str, *, timeout: float=15.0, max_response_bytes: int=8 * 1024 * 1024, max_attachment_bytes: int=_DEFAULT_ATTACHMENT_LIMIT, allow_insecure_http: bool=False, transport: httpx.AsyncBaseTransport | None=None): ...async def setup_status(self) -> ForgeResponse[JsonObject]: ...async def setup_founder(self, setup_token: str, username: str, password: str, display_name: str) -> ForgeResponse[JsonObject]: ...async def login(self, username: str, password: str) -> ForgeResponse[JsonObject]: ...async def register(self, invitation: str, username: str, password: str, display_name: str) -> ForgeResponse[JsonObject]: ...async def logout(self) -> ForgeResponse[Any]: ...async def capabilities(self) -> ForgeResponse[JsonObject]: ...async def profile(self) -> ForgeResponse[JsonObject]: ...async def update_profile(self, values: Mapping[str, str]) -> ForgeResponse[JsonObject]: ...async def projects(self) -> ForgeResponse[JsonObject]: ...async def create_project(self, name: str, slug: str) -> ForgeResponse[JsonObject]: ...async def documents(self, project: str) -> ForgeResponse[JsonObject]: ...async def document(self, project: str, document: str) -> ForgeResponse[JsonObject]: ...async def save_document(self, project: str, document: str, content: str, expected_sha256: str) -> ForgeResponse[JsonObject]: ...async def validate_project(self, project: str) -> ForgeResponse[JsonObject]: ...async def roles(self) -> ForgeResponse[JsonObject]: ...async def create_role(self, values: Mapping[str, Any]) -> ForgeResponse[JsonObject]: ...async def update_role(self, role_id: str, values: Mapping[str, Any]) -> ForgeResponse[JsonObject]: ...async def members(self) -> ForgeResponse[JsonObject]: ...async def update_member(self, user_id: str, memberships: Sequence[Mapping[str, str]], *, active: bool=True) -> ForgeResponse[Any]: ...async def create_invitation(self, memberships: Sequence[Mapping[str, str]], *, expires_hours: int=24) -> ForgeResponse[JsonObject]: ...async def areas(self, project: str='*') -> ForgeResponse[JsonObject]: ...async def create_area(self, values: Mapping[str, Any]) -> ForgeResponse[JsonObject]: ...async def messages(self, area_id: str, *, limit: int=100) -> ForgeResponse[JsonObject]: ...async def post_message(self, area_id: str, body: str, *, announcement: bool=False) -> ForgeResponse[JsonObject]: ...async def notes(self, project: str='*') -> ForgeResponse[JsonObject]: ...async def create_note(self, values: Mapping[str, Any]) -> ForgeResponse[JsonObject]: ...async def database_catalog(self, project: str) -> ForgeResponse[JsonObject]: ...async def database_rows(self, project: str, alias: str, table: str, *, limit: int=100, offset: int=0) -> ForgeResponse[JsonObject]: ...async def attachments(self, area_id: str, *, limit: int=100) -> ForgeResponse[JsonObject]: ...async def upload_attachment(self, area_id: str, source: str | os.PathLike[str]) -> ForgeResponse[JsonObject]: ...async def download_attachment(self, attachment_id: str, target: str | os.PathLike[str]) -> ForgeResponse[Path]: ...async def start_call(self, area_id: str, *, mode: str='video') -> ForgeResponse[JsonObject]: ...async def call_ticket(self, call_id: str) -> ForgeResponse[JsonObject]: ...async def audit(self, *, project: str | None=None, limit: int=100) -> ForgeResponse[JsonObject]: ...async def aclose(self) -> None: ...async def __aenter__(self) -> AsyncEditorControlPlaneClient: ...async def __aexit__(self, *_args: Any) -> None: ...Bu sayfa aşağıdaki sabit commitlerdeki davranışı açıklar. Yeni bir sürümde aynı davranışın sürdüğünü varsaymayın.