UserCommunicationBarringGetRequest

Bases: OCIRequest

Gets the Communication Barring settings for a user. The response is either a UserCommunicationBarringGetResponse or an ErrorResponse. This command only applies to groups in an Enterprise. This command will fail for groups in a Service Provider.

Attributes:

user_id (str):

Source code in src/mercury_ocip/commands/commands.py

@dataclass(kw_only=True)
class UserCommunicationBarringGetRequest(OCIRequest):
    """Gets the Communication Barring settings for a user.
        The response is either a UserCommunicationBarringGetResponse or an ErrorResponse.
        This command only applies to groups in an Enterprise. This command will fail for groups in a Service Provider.

    Attributes:

        user_id (str):

    """

    user_id: str = field(metadata={"alias": "userId"})

Responses

Bases: OCIDataResponse

Response to UserCommunicationBarringGetRequest. This command only applies to users in an Enterprise.

Attributes:

use_group_setting (bool):

profile_name (Optional[str]):

Source code in src/mercury_ocip/commands/commands.py

@dataclass(kw_only=True)
class UserCommunicationBarringGetResponse(OCIDataResponse):
    """Response to UserCommunicationBarringGetRequest.
        This command only applies to users in an Enterprise.

    Attributes:

        use_group_setting (bool):

        profile_name (Optional[str]):

    """

    use_group_setting: bool = field(metadata={"alias": "useGroupSetting"})

    profile_name: Optional[str] = field(default=None, metadata={"alias": "profileName"})

Bases: OCIResponse

Source code in src/mercury_ocip/commands/base_command.py

class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

Example Usage

from mercury_ocip.client import Client
from mercury_ocip.commands import UserCommunicationBarringGetRequest

client = Client()

command = UserCommunicationBarringGetRequest(
    user_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserCommunicationBarringGetRequest",
    user_id=...,
)

print(response)