Salesforce1 Mobile App Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Navigation with the sforce.one Object

The Salesforce1 Platform includes an event mechanism for navigation. This is exposed in Visualforce as a JavaScript object called sforce.one. It’s available in any page that appears in Salesforce1.

The sforce.one object provides the following functions. Reference the function using dotted notation from the sforce.one object. For example: sforce.one.navigateToSObject(recordId, view).

Function Description
back(​[refresh]) Navigates to the previous state that’s saved in the sforce.one history. It’s equivalent to clicking a browser’s Back button.

refresh is optional. By default, the page doesn’t refresh. Pass true to refresh the page if possible.
navigateToSObject(​recordId​[, view]) Navigates to an sObject record, specified by recordId. This record “home” has several views, which in Salesforce1 are available as slides that the user can swipe between.
view is optional and defaults to detail. view specifies the slide within record home to display initially. The possible values are as follows.
  • detail: the record detail slide
  • chatter: the Chatter slide
  • related: the view of related slide
navigateToURL(​url​[, isredirect]) Navigates to the specified URL.

Relative and absolute URLs are supported. Relative URLs are relative to the one.app domain, and retain navigation history. External URLs—that is, URLs that are outside the Salesforce1 app—open in a separate browser window.

Use relative URLs to navigate to different screens within your app. Use external URLs to allow the user to access a different site or app, where they can take actions that don’t need to be preserved in your app. To return to your app, the separate window that’s opened by an external URL must be closed when the user is finished with the other app. The new window has a separate history from your app, and this history is discarded when the window is closed. This also means that the user can’t click a Back button to go back to your app; the user must close the new window.

mailto:, tel:, geo:, and other URL schemes are supported for launching external apps and attempt to “do the right thing.” However, support varies by mobile platform and device. mailto: and tel: are reliable, but we recommend that you test any other URLs on a range of expected devices.

Only standard URL schemes are supported by navigateToURL. To access custom schemes, use window.location instead.

Note

isredirect is optional and defaults to false. Set it to true to indicate that the new URL should replace the current one in the navigation history.
navigateToFeed(​subjectId, type) Navigates to the feed of the specified type, scoped to the subjectId. For some feed types, the subjectId is required but ignored. For those feed types, pass the current user’s ID as the subjectId.
type is the feed type. The possible values are as follows.
  • BOOKMARKS: Contains all feed items saved as bookmarks by the context user. Pass the current user’s ID as the subjectId.
  • COMPANY: Contains all feed items except feed items of type TrackedChange. To see the feed item, the user must have sharing access to its parent. Pass the current user’s ID as the subjectId.
  • FILES: Contains all feed items that contain files posted by people or groups that the context user follows. Pass the current user’s ID as the subjectId.
  • GROUPS: Contains all feed items from all groups the context user either owns or is a member of. Pass the current user’s ID as the subjectId.
  • NEWS: Contains all updates for people the context user follows, groups the user is a member of, files and records the user is following, all updates for records whose parent is the context user, and every feed item and comment that mentions the context user or that mentions a group the context user is a member of. Pass the current user’s ID as the subjectId.
  • PEOPLE: Contains all feed items posted by all people the context user follows. Pass the current user’s ID as the subjectId.
  • RECORD: Contains all feed items whose parent is a specified record, which could be a group, user, object, file, or any other standard or custom object. When the record is a group, the feed also contains feed items that mention the group. When the record is a user, the feed contains only feed items on that user. Pass the record’s ID as the subjectId.
  • TO: Contains all feed items with mentions of the context user, feed items the context user commented on, and feed items created by the context user that are commented on. Pass the current user’s ID as the subjectId.
  • TOPICS: Contains all feed items that include the specified topic. Pass the topic’s ID as the subjectId.
navigateToFeedItemDetail(​feedItemId) Navigates to the specific feed item, feedItemId, and any associated comments.
navigateToRelatedList(​relatedListId, parentRecordId) Navigates to a related list for the parentRecordId. For example, to display a related list for a Warehouse object, the parentRecordId is Warehouse__c.Id.

relatedListId is the API name or ID of the related list to display.
navigateToList(​listViewId​, listViewName, scope) Navigates to the list view that’s specified by the listViewId, which is the ID of the list view to be displayed.

listViewName sets the title for the list view. It doesn’t need to match the actual name that’s saved for the list view. To use the saved name, set listViewName to null.

Set scope to the name of the sObject in the view, for example, “Account” or “MyObject__c”.
createRecord(​entityName​[, recordTypeId]) Opens the page to create a new record for the specified entityName, for example, “Account” or “MyObject__c”.

recordTypeId is optional and, if provided, specifies the record type for the created object.
editRecord(​recordId) Opens the page to edit the record specified by recordId.
Keep the following in mind when using the sforce.one object:
  • Calls to sforce.one.navigateToURL may result in an “Unsupported Page” error if the URL references standard pages for objects or Chatter pages. To avoid this error, ensure that the URL begins with a backslash (/_ui instead of _ui).
  • The sforce.one.createRecord method doesn’t respect Visualforce overrides on the standard action.