{user}
Sample Usage
Settings
| Setting Name | Type | Description |
|---|---|---|
| Positional | text | The user property to get |
| General Command Settings | ||
| trim | yes/no/left/right | If yes whitespace is removed before and after the command. If left, only whitespace to the left is removed. If right, only whitespace to the right is removed. |
The user command allows Text Blaze Business users to include information about the snippet user in the snippet.
Supported user properties are:
| Property | Description | Example |
|---|---|---|
| The user's email. | user@example.com | |
| os | The user's operating system. | mac |
Custom Properties
In addition to the built-in properties, you may configure custom user properties that can be set on a user-by-user level. For example, you may want to include employees names in your snippets. You can do that by creating a custom name property and then configuring it for each employee. Then your snippets could include the employee's name with {user: name}.
Custom properties can be configured on the Members tab of the organization. You can then set the properties for each individual in your organization.
Here is an example of a setting two properties for a user:
Configuring Custom Properties
There are several options available that allow you to configure the allowed data types and other aspects of a property.
Name and Description
The property name sets how you reference the property in snippets. If your property name was department. You would reference the the value in snippets with {user: department}. Once set, Text Blaze does not allow you to change a property's name.
The description provides additional information or instructions for users. It is optional.
User Editable
Organization administrators and editors can modify properties for all organization members from the Members tab.
If the property is user editable, individual users will also be able to modify their own properties.
Default Value
The default value for the property is the value that is used if an administrator or user has not yet set a user specific value.
Property Type
The remaining settings configure the allowed values for a property. There are four types of properties:
- Text: Text properties can be used to represent things like names or phone numbers. You can also specify validation rules using regular expressions.
- Number: Number properties only accept numeric values. You can configure maximum and minimum allowed values.
- Boolean: Boolean properties are yes/no values that can be turned on and off.
- Categorical: Categorical properties allow you to specify a drop down list of options that the user may select an option from.
Note that if you change the type of an existing property or add new validations to it, existing values for it will not be changed even if they are no longer valid. The changed type and validations only apply when manually updating the values.