Class HelpCenter.Builder

    • Method Detail

      • id

        public HelpCenter.WorkspaceIdStage id​(@NotNull
                                              java.lang.String id)

        The unique identifier for the Help Center which is given by Intercom.

        The unique identifier for the Help Center which is given by Intercom.

        Specified by:
        id in interface HelpCenter.IdStage
        Returns:
        Reference to this so that method calls can be chained together.
      • workspaceId

        public HelpCenter.CreatedAtStage workspaceId​(@NotNull
                                                     java.lang.String workspaceId)

        The id of the workspace which the Help Center belongs to.

        The id of the workspace which the Help Center belongs to.

        Specified by:
        workspaceId in interface HelpCenter.WorkspaceIdStage
        Returns:
        Reference to this so that method calls can be chained together.
      • createdAt

        public HelpCenter.UpdatedAtStage createdAt​(int createdAt)

        The time when the Help Center was created.

        The time when the Help Center was created.

        Specified by:
        createdAt in interface HelpCenter.CreatedAtStage
        Returns:
        Reference to this so that method calls can be chained together.
      • updatedAt

        public HelpCenter.IdentifierStage updatedAt​(int updatedAt)

        The time when the Help Center was last updated.

        The time when the Help Center was last updated.

        Specified by:
        updatedAt in interface HelpCenter.UpdatedAtStage
        Returns:
        Reference to this so that method calls can be chained together.
      • identifier

        public HelpCenter._FinalStage identifier​(@NotNull
                                                 java.lang.String identifier)

        The identifier of the Help Center. This is used in the URL of the Help Center.

        The identifier of the Help Center. This is used in the URL of the Help Center.

        Specified by:
        identifier in interface HelpCenter.IdentifierStage
        Returns:
        Reference to this so that method calls can be chained together.
      • url

        public HelpCenter._FinalStage url​(java.lang.String url)

        The URL for the help center, if you have a custom domain then this will show the URL using the custom domain.

        Specified by:
        url in interface HelpCenter._FinalStage
        Returns:
        Reference to this so that method calls can be chained together.
      • url

        public HelpCenter._FinalStage url​(java.util.Optional<java.lang.String> url)

        The URL for the help center, if you have a custom domain then this will show the URL using the custom domain.

        Specified by:
        url in interface HelpCenter._FinalStage
      • displayName

        public HelpCenter._FinalStage displayName​(java.lang.String displayName)

        The display name of the Help Center only seen by teammates.

        Specified by:
        displayName in interface HelpCenter._FinalStage
        Returns:
        Reference to this so that method calls can be chained together.
      • websiteTurnedOn

        public HelpCenter._FinalStage websiteTurnedOn​(java.lang.Boolean websiteTurnedOn)

        Whether the Help Center is turned on or not. This is controlled in your Help Center settings.

        Specified by:
        websiteTurnedOn in interface HelpCenter._FinalStage
        Returns:
        Reference to this so that method calls can be chained together.