Property Reference
The following Properties are currently built into Querki:
Common Properties
Meta-Properties
These are Properties that you use on other Properties, to manage how they work:
Space Properties
These are Properties that you use on a Space:
Advanced Properties
These are relatively complex Properties, mainly intended for programmers who are building more involved Spaces:
- Allow Links to Apps -- Optional/TrueOrFalse Type -- Should this Property allow Links to Things in Apps?
- Applies To -- List/Whole Number Type -- Which Kinds of Things can this Property be used on?
- Applies to Types -- Set/Thing Type -- Says which Types this meta-Property is relevant to
- Chart Labels -- List/Plain Text Type -- Gives the labels for each element of a Rating or Chart
- Computed Name -- Required/Text Type -- How to compute a name, for Things that don't have their own names
- Copy into Instances -- Required/TrueOrFalse Type -- If set, this Property's values will always be copied from the Model into newly-created Instances
- Deprecated -- Required/TrueOrFalse Type -- True iff this Thing is Deprecated.
- Duration -- Required/Duration Type -- Lets you define a length of time
- Google Font Name -- Optional/Plain Text Type -- The name of a Google Font to use in these styles
- Is Function -- Required/TrueOrFalse Type -- True iff this Thing is a Function.
- Is User Value Property -- Required/TrueOrFalse Type -- Add this flag to a Property, and set it to true, if this Property should have a separate value for each user.
- Is a Model -- Required/TrueOrFalse Type -- Is this Thing a Model?
- Link Kind -- List/Whole Number Type -- The Kind that this Property can contain
- Link to Models Only -- Required/TrueOrFalse Type -- Only allow this Property to Link to Models
- Model Only Property -- Required/TrueOrFalse Type -- Set this flag on a Property if that Property should be defined only on the Model, not on Instances
- Model View -- Optional/Large Text Type -- How this Model will be displayed
- Not Inherited -- Required/TrueOrFalse Type -- Should this Property be inherited from ancestors?
- Page Header -- Optional/Large Text Type -- Allows you to define the top of the page when looking at this Thing
- Person Roles -- Set/Thing Type -- This Property is only useful on Persons. It defines the Roles that this Person has.
You do not assign it directly; use the Sharing and Security page to manage which Roles each Person has.
- Role Permissions -- Set/Thing Type -- This Property is only relevant to Roles. It defines the Permissions that are granted to all Members
of this Role.
- Show External Rating Hint -- Required/TrueOrFalse Type -- Displays the current Rating Hint in its own text field, on the side.
- Summarizes Property -- Required/Thing Type -- Optional pointer from a Summary Property to the Property that it summarizes
- Summary Link -- Required/Thing Type -- Link to the Summary of this User Value
- User Level to Show This -- Required/Thing Type -- Describes the complexity of this Thing, in terms of what level of user experience it wants
- _apply -- Optional/Function -- A QL Expression that will be run when you name this Thing.
- _chooseFromProperty -- Optional/Thing Type -- When a Property is a Choice, this says which other Property the choices are drawn from.
- _chooseFromThing -- Optional/Thing Type -- When a Property is a Choice, this says which Thing the choices can be found on.
- _chooseFromThingThrough -- Optional/Thing Type -- When a Property is a Choice, this can list another Property that specifies which Thing the choices come from.
- _modelForType -- Required/Thing Type -- This receives a Model Type, and produces the Model that it is based upon.
Or, you can see the entire details as
one page.
Internal Properties
These are Properties that are internal only -- you can not create them yourself. But in some cases you can get at their values when needed:
- CSS -- Optional/CSS Type -- The actual CSS for a Stylesheet
- Can View History -- Set/Thing Type -- This permission controls whether someone is allowed to examine the History of this Space. This gives full read permission!
- Child Permissions Property -- Optional/Thing Type -- Points from a Permission on this Thing to the one to check for its children.
- Comment Text -- Optional/Text Type
- Default Value -- Required/Wrapped Value Type
- Email Body -- Required/Large Text Type -- The Contents of the email
- Email Results -- Required/Text Type -- Internal property, used in the process of sending email. Do not mess with this!
- Email Subject -- Required/Text Type -- The title of the email
- Email To -- Set/Thing Type -- Who should this email be sent to?
- Implements Abstract Function -- Required/Thing Type -- This should only be applied to Function Implementations, and says which Abstract Function this implements
- Instance Properties -- List/Thing Type -- Which Properties are relevant for Instances of this Model?
- Internal Property -- Optional/TrueOrFalse Type -- If set, this Property is system-internal, and should not be visible to end users.
- Is a Model -- Required/TrueOrFalse Type -- Is this Thing a Model?
- Is a Publishable Model -- Required/TrueOrFalse Type -- Indicates that Instances of this Model will be formally Published when they are ready
- Person to Identity Link -- Optional/Thing Type -- INTERNAL: points from a Space-scoped Person to a System-scoped Identity
- Property -- Required/Text Type
- Review Comments -- Required/Large Text Type -- The text part of a Review
- Sent To -- Set/Thing Type -- The Persons that this mail has already been sent to.
- Who Can Comment -- Set/Thing Type -- Who can comment on this Thing (or generally in this Space)
- Who Can Create -- Set/Thing Type -- Who else can make new Instances in this Space
- Who Can Design -- Set/Thing Type -- Who can design Models in this Space
- Who Can Edit -- Set/Thing Type -- Who else can edit Things in this Space
- Who Can Edit Children -- Set/Thing Type -- Who else can edit children of this Thing
- Who Can Explore -- Set/Thing Type -- These people are allowed to explore this Space, with functions like Search, Explore, All Things and so on. If disabled, these people will not see those features.
- Who Can Have User Values -- Set/Thing Type -- Who is allowed to define their own User Values (such as Ratings or Reviews)
- Who Can Manage Data -- Set/Thing Type -- Who can manage the Data contained in this Space
- Who Can Manage Security -- Set/Thing Type -- These people are allowed to manage security -- invite people, create Roles, and so on
- Who Can Manipulate Apps -- Set/Thing Type -- These people are allowed to add or remove Apps from this Space
- Who Can Moderate -- Set/Thing Type -- Who can moderate comments on this Thing
- Who Can Publish -- Set/Thing Type -- Who is allowed to Publish Instances in this Space; this is always defined on the Space itself, never on individual Things
- Who Can Read -- Set/Thing Type -- Who else can read Things in this Space
- Who Can Read After Publication -- Set/Thing Type -- After an Instance has been Published, who can read it?
- Who Can Read Comments -- Set/Thing Type -- Who can read the comments on this Thing?
- Who Can Use as an App -- Set/Thing Type -- These people are allowed to use this Space as an App. *Use with caution! These people will be able to see everything in this Space!*
- _App Gallery App Id -- Required/Thing Type -- The OID of this App
- _App Gallery Owner -- Required/Thing Type -- The owner of this App
- _Context Is Required -- Optional/TrueOrFalse Type
- _Defining Context -- Optional/_Expected Context Type
- _Email Address -- Optional/_Email Address Type -- An email address for a Person
- _Expected Context -- Required/_Expected Context Type
- _Function Context Types -- List/Thing Type
- _Function Return Type -- Optional/_Expected Context Type
- _Function Signature -- Required/_Function Signature Type
- _Gallery Entry Id -- Required/Thing Type -- This is set on the App, and contains the OID for this App in the Gallery
- _Gallery Space Details -- Required/Plain Text Type -- This is a specialized version of the standard Details Property, designed for describing an
App in the Gallery. For security reasons, it does not allow you to use any QL expressions, but you
can use all the usual QText markup.
- _Gallery Space Summary -- Required/Plain Text Type -- This is a specialized version of the standard Summary Property, designed for describing an
App in the Gallery. For security reasons, it does not allow you to use any QL expressions, but you
can use all the usual QText markup.
- _Instance Permissions -- Required/Thing Type -- Points to the Thing that holds the Instance Permissions for this Space
- _Invitation Status -- Optional/Thing Type -- The status of this Person's membership in this Space.
- _Is Reified Tag -- Optional/TrueOrFalse Type -- Set automatically when you turn a Tag into a real Thing
- _Is Simple Guest -- Optional/TrueOrFalse Type -- Set to true iff this Person appears to be coming from an Open Invitation, with no other Identity.
- _Is an App -- Optional/TrueOrFalse Type -- Set on a Space if that Space is an App
- _Killed Thing -- Required/TrueOrFalse Type -- The next step after Deprecated -- marks something that is considered formally dead.
- _Location State -- Optional/Text Type
- _Location Street Address -- Optional/Text Type
- _Location Town -- Optional/Text Type
- _Not Editable Property -- Required/TrueOrFalse Type -- Set on a Property that should not show up in the Editor.
- _Optional Parameters -- List/_Function Parameter Type
- _Permission Applies To -- Set/Thing Type
- _Required Parameters -- List/_Function Parameter Type
- _System Categories -- Set/Tag Type -- Categorization of Querki's System-level Things
- _abstractOver -- Required/Thing Type -- Says which field of an abstract function call should be used to derive its Type
- _adminCommand -- Optional/TrueOrFalse Type -- Signifies a command that can only be executed by a Querki Administrator.
- _commentNotifyBody -- Required/Plain Text Type
- _commentNotifyId -- Required/Whole Number Type
- _commentNotifySpaceOwner -- Required/Thing Type
- _commentNotifyThingName -- Required/Plain Text Type
- _defaultPermission -- Set/Thing Type -- Iff this Permission Property isn't set at all for a Thing, what values should be used?
- _deriveName -- Required/Thing Type -- Should this Thing's Link Name be automatically derived from its Name?
- _durationKindProp -- Required/Thing Type
- _durationQuantityProp -- Required/Whole Number Type
- _explicitlyShown -- Required/TrueOrFalse Type -- The inverse of InternalProp -- says that this is specifically to be shown to users, even though it otherwise wouldn't be.
- _getCommentNotifications -- Optional/TrueOrFalse Type
- _groupKey -- Optional/Wrapped Value Type -- The key of a single grouping that comes from _groupBy
- _groupMembers -- List/Wrapped Value Type -- The elements in a single grouping from _groupBy; use _groupElements to access these.
- _hasUnpublishedChanges -- Required/TrueOrFalse Type -- Set to true iff this Thing has been Published, then edited but not yet Updated.
- _implementationModel -- Required/TrueOrFalse Type
- _implementsTypes -- List/Thing Type -- The OIDs of the PTypes or Models that this Implementation handles
- _invitationNotifySender -- Required/Thing Type -- Who sent this invitation, as an IdentityId
- _invitationNotifyText -- Optional/Text Type -- The text of this invitation, if specified
- _invitationSenderName -- Required/Plain Text Type -- The display name of the sender of this invitation
- _invitationSpaceName -- Required/Plain Text Type -- The name of the Space this invitation is for
- _invitationSpaceOwner -- Required/Thing Type -- The Identity that owns the Space that is being invited to.
- _invitationURL -- Required/Plain Text Type -- The actual link to click on to accept this invitation
- _inviteRequiresMembership -- Optional/TrueOrFalse Type -- When set on a Shared Invitation Link, that Link will force recipients to sign up, rather than being Guests.
- _inviteRoleLink -- Optional/Thing Type -- Link from a Shared Invite to the Role that recipients will receive.
- _isInstancePermission -- Required/TrueOrFalse Type -- This Property is an Instance Permission
- _isOpenInvitation -- Optional/TrueOrFalse Type -- Flag on a Shared Invite, indicating that it is still open.
- _isPermission -- Required/TrueOrFalse Type -- This Property is a Permission
- _isShadow -- Required/TrueOrFalse Type -- Set to true by the system if this Thing is a shadow for a parent in an App.
- _minorUpdateInternal -- Required/TrueOrFalse Type -- Iff set, this Update should be considered Minor.
- _notifyRecordBody -- Required/Value has not been set -- The Body of this userland _notify()
- _notifyRecordSpaceDisplayName -- Required/Plain Text Type -- The Name of the Space of this userland _notify()
- _notifyRecordSpaceName -- Required/Plain Text Type -- The Link Name of the Space of this userland _notify()
- _notifyRecordSpaceOwner -- Required/Plain Text Type -- The Identity of the Space Owner of this userland _notify()
- _notifyRecordSubject -- Required/Plain Text Type -- The Subject of this userland _notify()
- _notifyRecordThing -- Optional/Thing Type -- The optional Thing from this userland _notify()
- _notifyRecordTopic -- Optional/Plain Text Type -- The optional Topic of this userland _notify()
- _oldOID -- Required/Thing Type -- (Import only) The original OID for this Imported Thing
- _publishNotes -- Optional/Large Text Type -- The notes to include with the next Publish or Update of this Thing.
- _publishedInstance -- Required/TrueOrFalse Type -- Set to true when this Instance gets Published.
- _spaceCommand -- Required/Thing Type -- Commands that can be executed from the Console must set this, and specify the required permissions.
- _spaceHasPublications -- Optional/TrueOrFalse Type -- This is set to true iff the Space contains Publishable Models
- _systemMessageBody -- Required/Text Type
- _systemMessageHeader -- Required/Large Text Type
- _url -- Required/URL Type -- The URL of a webpage, usually outside Querki
- _userValueProperty -- Required/Thing Type -- The Property of a User Value
- _userValueThing -- Required/Thing Type -- The Thing that a User Value is set on
- _userValueUser -- Required/_identityType -- The User who set a particular User Value
- _userValueValue -- Required/Wrapped Value Type -- The actual value of a User Value
Non-Inherited Properties
These Properties are specifically not inherited -- that is, if you set them on a Model, their values will not apply on sub-Models or Instances of that Model.
