struct StructureUserManagementTraitextension Google.StructureUserManagementTrait : Copyable, CustomStringConvertible, Equatable, Escapable, Hashable, Sendable, Trait, TraitEncodableUndocumented
-
The trait identifier.
Declaration
Swift
static let identifier: String -
List of all event types on the given Trait.
Currently, only
MatterTraittraits support any events, but this will likely expand to other traits in the future.Declaration
Swift
static let supportedEventTypes: [any Event.Type] -
List of all commands supported by the Trait’s definition. The commands supported by a specific Trait instance may vary.
Declaration
Swift
static var supportedCommandTypes: [any Command.Type] { get } -
Metadata about this
Trait.Declaration
Swift
let metadata: TraitMetadata -
Undocumented
Declaration
Swift
let attributes: Google.StructureUserManagementTrait.Attributes -
Creates a new Trait instance using data read from the given
TraitDecoder.Throws
HomeError.parseErrorwhen parsing fails.Declaration
Swift
init(decoder: TraitDecoder, interactionProxy: (any InteractionProxy)?, metadata: TraitMetadata) throwsParameters
decoderThe raw data representing this Trait.
interactionProxyProxy to the Interaction Client.
metadataMetadata about this Trait.
-
Undocumented
Declaration
Swift
init(interactionProxy: any InteractionProxy, metadata: TraitMetadata = TraitMetadata()) -
Writes this object to the given
TraitEncoder. ThrowsHomeError.encodingFailedif the data could not be encoded.Declaration
Swift
func encode(with encoder: TraitEncoder) throws -
Returns a Boolean value indicating whether two values are equal.
Equality is the inverse of inequality. For any values
aandb,a == bimplies thata != bisfalse.Declaration
Parameters
lhsA value to compare.
rhsAnother value to compare.
-
Hashes the essential components of this value by feeding them into the given hasher.
Implement this method to conform to the
Hashableprotocol. The components used for hashing must be the same as the components compared in your type’s==operator implementation. Callhasher.combine(_:)with each of these components.Important
In your implementation of
hash(into:), don’t callfinalize()on thehasherinstance provided, or replace it with a different instance. Doing so may become a compile-time error in the future.Declaration
Swift
func hash(into hasher: inout Hasher) -
Undocumented
Declaration
Swift
struct Attributesextension Google.StructureUserManagementTrait.Attributes : Copyable, Equatable, Escapable, Hashable, Sendable -
Undocumented
Declaration
Swift
struct UserMetadataextension Google.StructureUserManagementTrait.UserMetadata : AutomationValue, DefaultConstructible, Equatable, Hashable, Sendable, StructDataRepresentable -
Undocumented
Declaration
Swift
struct InvitationDetailsextension Google.StructureUserManagementTrait.InvitationDetails : AutomationValue, DefaultConstructible, Equatable, Hashable, Sendable, StructDataRepresentable -
Undocumented
Declaration
Swift
enum UserRoleextension Google.StructureUserManagementTrait.UserRole : AutomationValue, Enum, Enum32, Equatable, Hashable, PlatformEnum, RawRepresentable, Sendable -
Undocumented
Declaration
Swift
enum InvitationStatusextension Google.StructureUserManagementTrait.InvitationStatus : AutomationValue, Enum, Enum32, Equatable, Hashable, PlatformEnum, RawRepresentable, Sendable -
Undocumented
Declaration
Swift
typealias ListUsersInStructureRequest = Google.StructureUserManagementTrait.ListUsersInStructure.Request -
Undocumented
Declaration
Swift
typealias ListUsersInStructureResponse = Google.StructureUserManagementTrait.ListUsersInStructure.Response -
Undocumented
Declaration
Swift
struct ListUsersInStructureextension Google.StructureUserManagementTrait.ListUsersInStructure : Command, Sendable -
Declaration
Swift
func listUsersInStructure(structureId: String? = nil) async throws -> Google.StructureUserManagementTrait.ListUsersInStructureResponseParameters
structureId -
Undocumented
Declaration
Swift
static func listUsersInStructure(structureId: String?) -> AutomationCommand -
Undocumented
Declaration
Swift
typealias RemoveUserRequest = Google.StructureUserManagementTrait.RemoveUser.Request -
Undocumented
Declaration
Swift
struct RemoveUserextension Google.StructureUserManagementTrait.RemoveUser : Command, Sendable -
Declaration
Swift
func removeUser(structureId: String? = nil, obfuscatedUserId: String? = nil) async throwsParameters
structureIdobfuscatedUserId -
Undocumented
Declaration
Swift
static func removeUser(structureId: String?, obfuscatedUserId: String?) -> AutomationCommand -
Undocumented
Declaration
Swift
typealias CreateInvitationRequest = Google.StructureUserManagementTrait.CreateInvitation.Request -
Undocumented
Declaration
Swift
typealias CreateInvitationResponse = Google.StructureUserManagementTrait.CreateInvitation.Response -
Undocumented
Declaration
Swift
struct CreateInvitationextension Google.StructureUserManagementTrait.CreateInvitation : Command, Sendable -
Declaration
Swift
func createInvitation(intendedUserRole: Google.StructureUserManagementTrait.UserRole? = nil) async throws -> Google.StructureUserManagementTrait.CreateInvitationResponseParameters
intendedUserRole -
Undocumented
Declaration
Swift
typealias RevokeInvitationRequest = Google.StructureUserManagementTrait.RevokeInvitation.Request -
Undocumented
Declaration
Swift
struct RevokeInvitationextension Google.StructureUserManagementTrait.RevokeInvitation : Command, Sendable -
Declaration
Swift
func revokeInvitation(invitationId: String? = nil) async throwsParameters
invitationId -
Undocumented
Declaration
Swift
static func revokeInvitation(invitationId: String?) -> AutomationCommand -
Undocumented
Declaration
Swift
typealias ListInvitationsResponse = Google.StructureUserManagementTrait.ListInvitations.Response -
Undocumented
Declaration
Swift
struct ListInvitationsextension Google.StructureUserManagementTrait.ListInvitations : Command, Sendable -
Undocumented
Declaration
Swift
func listInvitations() async throws -> Google.StructureUserManagementTrait.ListInvitationsResponse -
Undocumented
Declaration
Swift
static func listInvitations() -> AutomationCommand