PageReference Methods

The following are methods for PageReference. All are instance methods.

  • forResource(resourceName, path)

    Create a PageReference for nested content inside a zip static resource, by name and path.

  • forResource(resourceName)

    Create a PageReference for a static resource, by name.

  • getAnchor()

    Returns the name of the anchor referenced in the page’s URL. That is, the part of the URL after the hashtag (#).

  • getContent()

    Returns the output of the page, as displayed to a user in a web browser.

  • getContentAsPDF()

    Returns the page in PDF, regardless of the <apex:page> component’s renderAs attribute.

  • getCookies()

    Returns a map of cookie names and cookie objects, where the key is a String of the cookie name and the the value contains the cookie object with that name.

  • getHeaders()

    Returns a map of the request headers, where the key string contains the name of the header, and the value string contains the value of the header.

  • getParameters()

    Returns a map of the query string parameters for the PageReference; both POST and GET parameters are included. The key string contains the name of the parameter, while the value string contains the value of the parameter.

  • getRedirect()

    Returns the current value of the PageReference object’s redirect attribute.

  • getRedirectCode()

    Returns the HTTP redirect code used when getRedirect() is set to true for the PageReference object.

  • getUrl()

    Returns the relative URL associated with the PageReference when it was originally defined, including any query string parameters and anchors.

  • setAnchor(anchor)

    Sets the URL’s anchor reference to the specified string.

  • setCookies(cookies)

    Creates a list of cookie objects. Used in conjunction with the Cookie class.

  • setRedirect(redirect)

    Sets the value of the PageReference object’s redirect attribute. If set to true, a redirect is performed through a client side redirect.

  • setRedirectCode(redirectCode)

    Sets the HTTP redirect code to use for the PageReference object when setRedirect(redirect) is set to true.