Site クラス

署名

public static System.PageReference changePassword(String newPassword, String verifyNewPassword, String oldPassword)

パラメータ

newPassword

型: String

verifyNewPassword

型: String

oldPassword

型: String

省略可能。

戻り値

型: System.PageReference

使用方法

API バージョン 30.0 以降では、このメソッドへのコールはトランザクションを自動的にコミットしません。API バージョン 30.0 より前では、このメソッドへのコールはトランザクションをコミットするため、コール前のセーブポイントにロールバックできません。

署名

public static Id createExternalUser(SObject name, String accountId)

パラメータ

name

型: SObject

ユーザを作成するために必要な情報。

accountId

型: String

ユーザを関連付ける取引先の ID。

戻り値

型: Id

このメソッドで作成されるユーザの ID。

使用方法

このメソッドは、ユーザの作成に失敗すると、Site.ExternalUserCreateException を発生させます。

nickname 項目は、createExternalUser メソッドを使用する場合に User sObject に必要です。

API バージョン 30.0 以降では、このメソッドへのコールはトランザクションを自動的にコミットしません。API バージョン 30.0 より前では、このメソッドへのコールはトランザクションをコミットするため、コール前のセーブポイントにロールバックできません。

署名

public static Id createExternalUser(SObject name, String accountId, String password)

パラメータ

name

型: SObject

ユーザを作成するために必要な情報。

accountId

型: String

ユーザを関連付ける取引先の ID。

password

型: String

コミュニティまたはポータルユーザのパスワード。指定しない場合、または null または空の文字列が設定されている場合、このメソッドは新しいパスワードメールをポータルユーザに送信します。

戻り値

型: Id

このメソッドで作成されるユーザの ID。

使用方法

このメソッドは、ユーザの作成に失敗すると、Site.ExternalUserCreateException を発生させます。

nickname 項目は、createExternalUser メソッドを使用する場合に User sObject に必要です。

API バージョン 30.0 以降では、このメソッドへのコールはトランザクションを自動的にコミットしません。API バージョン 30.0 より前では、このメソッドへのコールはトランザクションをコミットするため、コール前のセーブポイントにロールバックできません。

署名

public static Id createExternalUser(SObject name, String accountId, String password, Boolean sendEmailConfirmation)

パラメータ

name

型: SObject

ユーザを作成するために必要な情報。

accountId

型: String

ユーザを関連付ける取引先の ID。

password

型: String

コミュニティまたはポータルユーザのパスワード。指定しない場合、または null または空の文字列が設定されている場合、このメソッドは新しいパスワードメールをポータルユーザに送信します。

sendEmailConfirmation

型: Boolean

新しいユーザメールがポータルユーザに送信されるかどうかを指定します。新しいユーザメールをポータルユーザに送信するには、true に設定します。デフォルトは false で、新しいユーザメールは送信されません。

戻り値

型: Id

このメソッドで作成されるユーザの ID。

使用方法

このメソッドは、ユーザの作成に失敗すると、Site.ExternalUserCreateException を発生させます。

nickname 項目は、createExternalUser メソッドを使用する場合に User sObject に必要です。

API バージョン 30.0 以降では、このメソッドへのコールはトランザクションを自動的にコミットしません。API バージョン 30.0 より前では、このメソッドへのコールはトランザクションをコミットするため、コール前のセーブポイントにロールバックできません。

署名

public static ID createPersonAccountPortalUser(sObject user, String ownerId, String password)

パラメータ

user

型: sObject

ownerId

型: String

password

型: String

戻り値

型: ID

使用方法

API バージョン 30.0 以降では、このメソッドへのコールはトランザクションを自動的にコミットしません。API バージョン 30.0 より前では、このメソッドへのコールはトランザクションをコミットするため、コール前のセーブポイントにロールバックできません。

署名

public static ID createPersonAccountPortalUser(sObject user, String ownerId, String recordTypeId, String password)

パラメータ

user

型: sObject

ownerId

型: String

recordTypeId

型: String

password

型: String

戻り値

型: ID

使用方法

API バージョン 30.0 以降では、このメソッドへのコールはトランザクションを自動的にコミットしません。API バージョン 30.0 より前では、このメソッドへのコールはトランザクションをコミットするため、コール前のセーブポイントにロールバックできません。

署名

public static ID createPortalUser(sObject user, String accountId, String password, Boolean sendEmailConfirmation)

パラメータ

user

型: sObject

accountId

型: String

password

型: String

(省略可能) ポータルユーザのパスワードです。指定しない場合、または null または空の文字列が設定されている場合、このメソッドは新しいパスワードメールをポータルユーザに送信します。

sendEmailConfirmation

型: Boolean

(省略可能) 新しいユーザメールがポータルユーザに送信されるかどうかを指定します。新しいユーザメールをポータルユーザに送信するには、true に設定します。デフォルトは false で、新しいユーザメールは送信されません。

戻り値

型: ID

使用方法

nickname 項目は、createPortalUser メソッドを使用する場合にユーザの sObject に必要です。

API バージョン 30.0 以降では、このメソッドへのコールはトランザクションを自動的にコミットしません。API バージョン 30.0 より前では、このメソッドへのコールはトランザクションをコミットするため、コール前のセーブポイントにロールバックできません。

署名

public static Boolean forgotPassword(String username)

パラメータ

username

型: String

戻り値

型: Boolean

使用方法

API バージョン 30.0 以降では、このメソッドへのコールはトランザクションを自動的にコミットしません。API バージョン 30.0 より前では、このメソッドへのコールはトランザクションをコミットするため、コール前のセーブポイントにロールバックできません。

署名

public static String getAdminEmail()

戻り値

型: String

署名

public static ID getAdminId()

戻り値

型: ID

署名

public static String getAnalyticsTrackingCode()

戻り値

型: String

署名

この項目では、現在の要求の URL ではなく、参照元ページの URL を返す場合があります。返された値にはパスプレフィックスが含まれており、値の末尾は常に / 文字です。現在の要求がサイト要求ではない場合、このメソッドは null を返します。現在の要求がサイト要求ではない場合、このメソッドは null を返します。このメソッドは API バージョン 30.0 の getBaseUrl に置き換えられました。

public static String getCurrentSiteUrl()

戻り値

型: String

使用方法

代わりに、getBaseUrl() を使用してください。

署名

public static String getBaseCustomUrl()

戻り値

型: String

使用方法

このメソッドにより getCustomWebAddress() が置き換えられます。またこのメソッドにはカスタム URL のパスプレフィックスが含まれます。

署名

public static String getBaseInsecureUrl()

戻り値

型: String

署名

public static String getBaseRequestUrl()

戻り値

型: String

署名

public static String getBaseSecureUrl()

戻り値

型: String

署名

public static String getBaseUrl()

戻り値

型: String

使用方法

getCurrentSiteUrl() は、このメソッドに置き換えられます。

署名

要求のカスタム URL の末尾が Force.com ではない場合はカスタム URL を返し、そうでない場合はサイトの主カスタム URL を返します。どちらも存在しない場合は、null を返します。この URL のパスは、要求のカスタム URL にパスプレフィックスがあっても、常にルートです。現在の要求がサイト要求ではない場合、このメソッドは null を返します。返された値の末尾は常に / 文字です。

public static String getCustomWebAddress()

戻り値

型: String

使用方法

代わりに、getBaseCustomUrl() を使用してください。

署名

public static String getDomain()

戻り値

型: String

署名

public static String getErrorDescription()

戻り値

型: String

署名

public static String getErrorMessage()

戻り値

型: String

署名

public static String getExperienceId()

戻り値

型: String

使用方法

動的ログイン環境を実装するには、getExperienceId および setExperienceId メソッドを使用します。setExperienceId を使用して、または次のエンドポイントを expid_value で拡張してエクスペリエンス ID を設定できます。

• community-url/services/oauth2/authorize/expid_value
• community-url/idp/endpoint/HttpPost/expid_value
• community-url/idp/endpoint/HttpRedirect/expid_value
• community-url_login_page/expid={value}
• community-url/CommunitiesSelfReg?expid={value}
• secur/forgotpassword.jsp?expid={value}

ブラウザが expid 値を含む URL を読み込むときに Cookie が設定されます。

署名

public static String getMasterLabel()

戻り値

型: String

署名

public static String getName()

戻り値

型: String

署名

public static String getOriginalUrl()

戻り値

型: String

署名

public static String getPasswordPolicyStatement()

戻り値

型: String

署名

public static String getPathPrefix()

戻り値

型: String

署名

現在のサイトの URL パスプレフィックスを返します。たとえば、サイト URL が myco.force.com/partners である場合、/partners がパスのプレフィックスです。プレフィックスが定義されていない場合は null を返します。 現在の要求がサイト要求ではない場合、このメソッドは null を返します。

public static String getPrefix()

戻り値

型: String

署名

public static String getSiteId()

戻り値

型: Id

署名

public static System.PageReference getTemplate()

戻り値

型: System.PageReference

署名

public static String getSiteType()

戻り値

型: String

署名

public static String getSiteTypeLabel()

戻り値

型: String

署名

public static Boolean isLoginEnabled()

戻り値

型: Boolean

署名

public static Boolean isPasswordExpired()

戻り値

型: Boolean

署名

public static Boolean isRegistrationEnabled()

戻り値

型: Boolean

署名

public static Boolean isValidUsername(String username)

パラメータ

username

型: String

有効性をテストするユーザ名。

戻り値

型: Boolean

署名

public static System.PageReference login(String username, String password, String startUrl)

パラメータ

username

型: String

password

型: String

startUrl

型: String

戻り値

型: System.PageReference

使用方法

Site.login をコールする前のすべての DML ステートメントがコミットされます。Site.login をコールする前に作成されたセーブポイントにロールバックできません。

署名

public static void setExperienceId(String expIdValue)

パラメータ

expIdValue

型: String

ユーザのログイン環境を示す値。

この値には最大 30 文字の英数字のみを使用します。

使用方法

動的ログイン環境を実装する場合は、setExperienceId を使用します。ログイン環境とは、ログインページとそれに関連付けられたセカンダリページを指します (2 要素認証やログインフローなど)。ユーザは誰か、またはユーザはどこからログインしているかに応じて、異なるログイン環境を定義します。たとえば、ユーザの場所に基づいて異なる登録プロセスを要求できます。この場合、expIdValue には都道府県または国コードが含まれます。ユーザがログインすると、URL にはエクスペリエンス ID パラメータ {expid} が含まれます。{expid} パラメータは、.jp など、expIdValue に保存されている値で置き換えられます。すると、ユーザは日本語ログイン環境にリダイレクトされます。

例

署名

public static Void setPortalUserAsAuthProvider(sObject user, String contactId)

パラメータ

user

型: sObject

contactId

型: String

戻り値

型: Void

使用方法

署名

public static void validatePassword(SObject user, String password, String confirmPassword)

パラメータ

user

型: SObject

コミュニティへのセルフ登録中にパスワードを作成しようとしているユーザ。

password

型: String

ユーザが入力したパスワード。

confirmPassword

型: String

パスワードの確認のためにユーザが再入力したパスワード。

戻り値

型: void

使用方法