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

Network

Represents a community, which is a customizable public or private space where employees, end-customers, and partners can collaborate on best practices and business processes. Communities give you the opportunity to share information, records, and files with coworkers and related external stakeholders all in one place. This object is available in API version 26.0 and later.

Supported Calls

describeSObjects(), query(), retrieve(), update()

Special Access Rules

This object is available only if Salesforce Communities is enabled in your organization.

Fields

Field Name Details
CaseCommentEmailTemplateId
Type
reference
Properties
Filter, Group, Nillable, Sort, Update
Description
ID of the email template used when submitting a comment on a case. This field is available in API version 28.0 and later.
ChangePasswordEmailTemplateId
Type
reference
Properties
Filter, Group, Sort, Update
Description
ID of the email template used when notifying a user that their password has been reset.
Description
Type
string
Properties
Filter, Group, Nillable, Sort, Update
Description
Description of the community.
EmailFooterLogoId
Type
reference
Properties
Filter, Group, Nillable, Sort, Update
Description
ID of the Document object that displays as an image in the footer of community Chatter emails.
EmailFooterText
Type
string
Properties
Filter, Nillable, Sort, Update
Description
Text that displays in the footer of community Chatter emails.
EmailSenderAddress
Type
email
Properties
Filter, Group, Sort
Description
Read only. Email address from which community emails are sent.

To change the EmailSenderAddress value, you must first specify NewSenderAddress, which triggers the sending of an address change verification email. After you complete the address verification process, EmailSenderAddress changes to the specified NewSenderAddress.

Note
EmailSenderName
Type
string
Properties
Filter, Group, Sort, Update
Description
Name from which community emails are sent.
ForgotPasswordEmailTemplateId
Type
reference
Properties
Filter, Group, Sort, Update
Description
ID of the email template used when a user forgets their password.
Name
Type
string
Properties
Filter, Group, Sort, Update
Description
The name of the community.
NewSenderAddress
Type
email
Properties
Filter, Group, Nillable, Sort, Update
Description
Email address that has been entered as the new value for EmailSenderAddress but has not been verified yet. After a user has requested to change the sender email address and has successfully responded to the verification email, the NewSenderAddress value overwrites the value in EmailSenderAddress. This becomes the email address from which community emails are sent.

  • If verification is pending for a new email address and you set NewSenderAddress to null, this cancels the verification request.
  • NewSenderAddress is automatically set to null after EmailSenderAddress has been set to the new verified address.
  • If verification is pending for a new email address and you specify a different new address for this field, only the latest value is retained and used for verification.

Note
OptionsAllowMembersToFlag
Type
boolean
Properties
Filter, Update
Description
Determines whether users can flag posts, comments, or files as inappropriate in the community.

This field is available in API version 29.0 and later. The ability to flag files is available in version 30.0 and later.
OptionsInvitationsEnabled
Type
boolean
Properties
Filter, Update
Description
Determines whether users can invite others to the community.
OptionsKnowledgeableEnabled
Type
boolean
Properties
Filter
Description
Determines whether users can see knowledgeable people for topics and endorse people for topics.
OptionsPrivateMessagesEnabled
Type
boolean
Properties
Filter
Description
Determines whether users can send and receive Chatter messages in the community.
OptionsSelfRegistrationEnabled
Type
boolean
Properties
Filter, Update
Description
Determines whether external users can self-register to join the community. External users are users with Community, Customer Portal, or partner portal licenses. If true, displays a Not a member? link on the login page that points to the default self-registration page. This field is available in API version 28.0 and later.
OptionsSendWelcomeEmail
Type
boolean
Properties
Filter, Update
Description
Determines whether a welcome email is sent when a new user is added to the community.
OptionsSiteAsContainerEnabled
Type
boolean
Properties
Filter, Update
Description
Determines whether the community uses Site.com pages instead of tabs.

This field is available in API version 29.0 and later.
SelfRegProfileId
Type
reference
Properties
Filter, Group, Nillable, Sort, Update
Description
ID of the profile assigned to users who self register. Only applies if self registration is enabled for the community.

This field is available in API version 29.0 and later.
Status
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort, Update
Description
Status of the community. Available values are:
  • Live—The community is online and members can access it. Label is Published.
  • DownForMaintenance—The community was previously published, but was taken offline. Members with “Create and Manage Communities” can still access the setup for offline communities regardless of profile or membership. Members are not able to access offline communities, but they still appear in the user interface drop-down as CommunityName (Offline). Label is Offline.
  • UnderConstruction—The community has not yet been published. Users with “Create and Manage Communities” can access communities in this status if their profile is associated with the community.

    Once a community is published, it can never be in this status again. Label is Preview.
UrlPathPrefix
Type
string
Properties
Filter, Group, Sort, Update
Description
The UrlPathPrefix is a unique string at the end of the URL for this community. For example, in the community URL UniversalTelco.force.com/customers, customers is the UrlPathPrefix.
WelcomeEmailTemplateId
Type
reference
Properties
Filter, Group, Sort, Update
Description
ID of the email template used when sending welcome emails to new community members.

Usage

Use this object to find, view, and update communities in your organization. If you have “Modify All Data,” “View All Data,” or “Create and Manage Communities,” you can view all communities in the organization. Users without these permissions only see the Preview or Published communities that they’re members of. If you have “Create and Manage Communities,” you can customize community settings.