System.Tether.AppProfile.TLocalAction

From Appmethod Libraries
Jump to: navigation, search

System.Tether.AppProfile.TCustomLocalItemSystem.Classes.TCollectionItemSystem.Classes.TPersistentSystem.TObjectTLocalAction

Object Pascal

TLocalAction = class(TCustomLocalItem)

C++

class PASCALIMPLEMENTATION DECLSPEC_DRTTI TLocalAction : public TCustomLocalItem

Properties

Type Visibility Source Unit Parent
class public
System.Tether.AppProfile.pas
System.Tether.AppProfile.hpp
System.Tether.AppProfile System.Tether.AppProfile

Description

Represents a shared action from the point of view of the profile that is sharing that action. See also TRemoteAction.

TLocalAction is a subclass of TCustomLocalItem that wraps an instance of TContainedAction. Use the Action property to set this wrapped action.

Local actions are collection actions. When you create a local action, you must specify a parent TCollection that takes ownership of the local action.

A local action provides a Name that uniquely identifies the action within the Profile that shares the action, and a Hint that describes the action.

Call Broadcast on a local action to announce changes to the action to remote profiles at any time. You can also make NotifyUpdates True to enable automatic notifications when the value of the action changes.

IsPublic determines whether or not the local action must be shared with remote profiles. By default, local actions are public (IsPublic is True). Application profiles use protected (IsPublic is False) local actions for one-time exchanges of data, such as receiving strings or receiving streams.

Kind determines whether the value of the local action is defined locally (default), or is mirrored from a remote action. When the value of a local action is mirrored (Kind is TTetheringRemoteKind.Mirror), the value is obtained from another action shared by a remote profile. The Kind of the remote action must be TTetheringRemoteKind.Shared.

See Also