Object Reference for Salesforce and Force.com

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

This content describes an older version of this product. View Latest

WorkBadgeDefinition

The attributes of a badge including the badge name, description, and image. Each WorkBadge record must have a lookup to a WorkBadgeDefinition as badge attributes, such as badge name, badge description, and badge image, are derived from the WorkBadgeDefinition object.

Supported Calls

create(),  delete(),  describeLayout(),  describeSObjects(),  getDeleted(),  getUpdated(),  query(),  retrieve(), search(), undelete(),  update(),  upsert()

Additional Considerations and Related Objects

WorkBadgeDefinition has a field called ImageUrl that references a DocumentID. This is a required field for creating a Badge.

To grant “giver” access to a WorkBadgeDefinition, you must also create the WorkAccess (and the related WorkAccessShare) records.

Each WorkBadgeDefinition has an ImageUrl field that must be populated with a DocumentID of the Document record containing the badge image.

Fields

Field Name Details
Description
Type
textarea
Properties
Create, Update
Description
Required. Limit: 4000 characters. The description of the badge and what it means to receive this badge.
GivenBadgeCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of badges given per user or across all users.

This field can’t be added in a list view or referenced in a formula field.

Note
ImageUrl
Type
url
Properties
Create, Filter, Group, Sort, Update
Description
Required. This is the badge image that will be displayed in the UI. Use DocumentID or ImageURL.
IsActive
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Represents whether a WorkBadgeDefinition is active and available in the UI.
IsCompanyWide
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Represents a special class of badges known as Company Badges. Company badges are visible to the entire company and visible in specific list view filters.

If this field is selected in a community organization, all internal and all community users can give it. If this field is not selected in a community organization, the badge can’t be given by people with sharing, but all other internal and community users can give it.

Note
IsLimitPerUser
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the badge limit is per user (true) or across all users (false). The default value is false.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The time stamp that indicates when the current user last viewed a record that is related to this WorkBadgeDefinition.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The time stamp that indicates when the current user last viewed this WorkBadgeDefinition. If this value is null, this record might have been only referenced (LastReferencedDate) and not viewed.
LimitNumber
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The badge limit per user or across all users.
LimitStartDate
Type
dateTime
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The start date of the badge limit. The date can be reset to the current date.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
Required. Name of the Badge. Label: Badge Title.
NetworkId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the community that this WorkBadgeDefinition is associated with. This field is available only if Salesforce Communities is enabled in your organization.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Salesforce User ID for User who is the Owner of the WorkBadgeDefinition record (usually the creator of the record)
RewardFundId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Salesforce unique ID for the WorkRewardFund that is associated with this WorkBadgeDefinition. WorkBadgeDefinition records with a RewardFundID indicate a Reward Badge.