Viam SDK
    Preparing search index...

    Class UserPermission

    A UserPermission describes the Users a set of permissions is granted to.

    from message viam.app.v1.UserPermission

    Hierarchy

    Index
    permissions: Permission[]

    permissions are the methods these Users may invoke, by resource. A User named here with no permissions may invoke nothing.

    from field: repeated viam.app.v1.Permission permissions = 2;

    user?: User

    user is a single User these permissions apply to. Superseded by users: prefer users in new writers, and expect readers to ignore user when users is set.

    from field: viam.app.v1.User user = 1;

    users: User[]

    users are the Users these permissions apply to. A User can be listed in only one UserPermission for a set of UserPermissions, counting both users and user.

    from field: repeated viam.app.v1.User users = 3;

    fields: FieldList
    runtime: ProtoRuntime
    typeName: "viam.app.v1.UserPermission"
    • Parse from binary data, merging fields.

      Repeated fields are appended. Map entries are added, overwriting existing keys.

      If a message field is already present, it will be merged with the new data.

      Parameters

      • bytes: Uint8Array
      • Optionaloptions: Partial<BinaryReadOptions>

      Returns this

    • Parse a message from a JSON value.

      Parameters

      • jsonValue: JsonValue
      • Optionaloptions: Partial<JsonReadOptions>

      Returns this

    • Parse a message from a JSON string.

      Parameters

      • jsonString: string
      • Optionaloptions: Partial<JsonReadOptions>

      Returns this

    • Retrieve the MessageType of this message - a singleton that represents the protobuf message declaration and provides metadata for reflection- based operations.

      Returns MessageType<UserPermission>

    • Serialize the message to binary data.

      Parameters

      • Optionaloptions: Partial<BinaryWriteOptions>

      Returns Uint8Array

    • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

      Parameters

      • Optionaloptions: Partial<JsonWriteOptions>

      Returns JsonValue

    • Override for serialization behavior. This will be invoked when calling JSON.stringify on this message (i.e. JSON.stringify(msg)).

      Note that this will not serialize google.protobuf.Any with a packed message because the protobuf JSON format specifies that it needs to be unpacked, and this is only possible with a type registry to look up the message type. As a result, attempting to serialize a message with this type will throw an Error.

      This method is protected because you should not need to invoke it directly -- instead use JSON.stringify or toJsonString for stringified JSON. Alternatively, if actual JSON is desired, you should use toJson.

      Returns JsonValue

    • Serialize the message to a JSON string.

      Parameters

      • Optionaloptions: Partial<JsonWriteStringOptions>

      Returns string

    • Parameters

      • bytes: Uint8Array
      • Optionaloptions: Partial<BinaryReadOptions>

      Returns UserPermission

    • Parameters

      • jsonString: string
      • Optionaloptions: Partial<JsonReadOptions>

      Returns UserPermission