この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

Site クラス

Site クラスを使用して、Force.com サイトを管理します。

名前空間

使用方法

site.createPortalUser の使用時に例外が発生した場合、null が返され、サイトのシステム管理者にはメールが送信されます。サイトの詳細は、Salesforce オンラインヘルプの「Force.com サイトの概要」を参照してください。

Force.com Sites の例

次の例では、クラス SiteRegisterController を作成します。このクラスは Visualforce ページ (下記マークアップを参照) を使用して、新規カスタマーポータルユーザを登録します。

次の例では、新しいポータルユーザと関連付ける取引先の取引先 ID を入力する必要があります。取引先所有者をこのコード例が機能するロール階層に追加する必要もあります。詳細は、Salesforce オンラインヘルプの「カスタマーポータルの設定」を参照してください。

メモ

1/**
2 * An Apex class that creates a portal user
3 */
4public class SiteRegisterController {
5    // PORTAL_ACCOUNT_ID is the account on which the contact will be created on 
6    //  and then enabled as a portal user.
7    //Enter the account ID in place of <portal_account_id> below.
8    private static Id PORTAL_ACCOUNT_ID = '<portal_account_id>';
9    
10    public SiteRegisterController () {
11    }
12
13    public String username {get; set;}
14    public String email {get; set;}
15    public String password {get; set {password = value == null ? value : value.trim(); } }
16    public String confirmPassword {get; set { confirmPassword = 
17        value == null ? value : value.trim(); } }
18    public String communityNickname {get; set { communityNickname = \
19        value == null ? value : value.trim(); } }
20      
21    private boolean isValidPassword() {
22        return password == confirmPassword;
23    }
24    
25    public PageReference registerUser() {
26        // If password is null, a random password is sent to the user
27        if (!isValidPassword()) {
28           ApexPages.Message msg = new ApexPages.Message(ApexPages.Severity.ERROR, 
29               Label.site.passwords_dont_match);
30           ApexPages.addMessage(msg);
31            return null;
32        }    
33        User u = new User();
34        u.Username = username;
35        u.Email = email;
36        u.CommunityNickname = communityNickname;
37        
38        String accountId = PORTAL_ACCOUNT_ID;
39
40        // lastName is a required field on user, but if it isn't specified, 
41           the code uses the username
42        String userId = Site.createPortalUser(u, accountId, password);
43        if (userId != null) { 
44            if (password != null && password.length() > 1) {
45                return Site.login(username, password, null);
46            }
47            else {
48                PageReference page = System.Page.SiteRegisterConfirm;
49                page.setRedirect(true);
50                return page;
51            }
52        }
53        return null;
54    }
55}

1/**
2 * Test class.
3 */
4@isTest
5private class SiteRegisterControllerTest {
6    // Test method for verifying the positive test case
7    static testMethod void testRegistration() {
8        SiteRegisterController controller = new SiteRegisterController();
9        controller.username = 'test@force.com';
10        controller.email = 'test@force.com';
11        controller.communityNickname = 'test';
12        // registerUser always returns null when the page isn't accessed as a guest user
13        System.assert(controller.registerUser() == null);
14        controller.password = 'abcd1234';
15        controller.confirmPassword = 'abcd123';
16        System.assert(controller.registerUser() == null);
17    }
18}

次は、上記の SiteRegisterController Apex コントローラを使用する Visualforce 登録ページです。

1<apex:page id="Registration" showHeader="false" controller=
2    "SiteRegisterController" standardStylesheets="true">
3  <apex:outputText value="Registration"/>
4  <br/>
5  <apex:form id="theForm">
6    <apex:messages id="msg" styleClass="errorMsg" layout="table" style="margin-top:1em;"/>
7    <apex:panelGrid columns="2" style="margin-top:1em;">
8      <apex:outputLabel value="{!$Label.site.username}" for="username"/>
9      <apex:inputText required="true" id="username" value="{!username}"/>
10      <apex:outputLabel value="{!$Label.site.community_nickname}" 
11          for="communityNickname"/>
12      <apex:inputText required="true" id="communityNickname" required="true" 
13          value="{!communityNickname}"/>
14      <apex:outputLabel value="{!$Label.site.email}" for="email"/>
15      <apex:inputText required="true" id="email" required="true" value="{!email}"/>
16      <apex:outputLabel value="{!$Label.site.password}" for="password"/>
17      <apex:inputSecret id="password" value="{!password}"/>
18      <apex:outputLabel value="{!$Label.site.confirm_password}" for="confirmPassword"/>
19      <apex:inputSecret id="confirmPassword" value="{!confirmPassword}"/>
20      <apex:outputText value=""/>
21      <apex:commandButton action="{!registerUser}" value="{!$Label.site.submit}" 
22          id="submit"/>
23    </apex:panelGrid>
24  </apex:form>
25cod</apex:page>

createPersonAccountPortalUser メソッドのサンプルコードは、上記のサンプルコードとほぼ同じですが、次の点が変更されています。

PORTAL_ACCOUNT_ID のすべてのインスタンスを OWNER_ID に置き換えています。
accountID ではなく ownerID を決定し、次のコードブロックに置き換えることにより、CreatePortalUser メソッドではなく createPersonAccountPortalUser メソッドを使用しています。
1String accountId = PORTAL_ACCOUNT_ID; 2String userId = Site.createPortalUser(u, accountId, password);
置換後
1String ownerId = OWNER_ID; 2String userId = Site.createPersonAccountPortalUser(u, ownerId, password);

Site メソッド

Site のメソッドは次のとおりです。すべてのメソッドが静的です。

changePassword(newPassword, verifyNewPassword, oldPassword)

現在のユーザのパスワードを変更します。

署名

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 より前では、このメソッドへのコールはトランザクションをコミットするため、コール前のセーブポイントにロールバックできません。

createExternalUser(name, accountId)

指定された取引先のコミュニティまたはポータルユーザを作成し、コミュニティに関連付けます。

署名

public static Id createExternalUser(SObject name, String accountId)

パラメータ

name: 型: SObject; ユーザを作成するために必要な情報。
accountId: 型: String; ユーザを関連付ける取引先の ID。

戻り値

型: Id

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

使用方法

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

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

このメソッドは、サイトがカスタマーポータルに関連付けられている場合にのみ有効です。

メモ

createExternalUser(name, accountId, password)

指定された取引先のコミュニティまたはポータルユーザを作成し、コミュニティに関連付けます。このメソッドでは、指定されたパスワードが記載されたメールをユーザに送信します。

署名

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 に必要です。

このメソッドは、サイトがカスタマーポータルに関連付けられている場合にのみ有効です。

メモ

createExternalUser(name, accountId, password, sendEmailConfirmation)

コミュニティまたはポータルユーザを作成し、指定された取引先に関連付けます。このメソッドでは、指定されたパスワードと新規ユーザの確認が記載されたメールをユーザに送信します。

署名

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 に必要です。

このメソッドは、サイトがカスタマーポータルに関連付けられている場合にのみ有効です。

メモ

createPersonAccountPortalUser(user, ownerId, password)

ゲストユーザのプロファイルに定義されているデフォルトのレコードタイプを使用して個人取引先を作成し、サイトのポータルでその個人取引先を有効化します。

署名

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

パラメータ

user: 型: sObject
ownerId: 型: String
password: 型: String

戻り値

型: ID

使用方法

この方法は、サイトがカスタマーポータルに関連付けられている場合、およびデフォルトの新しいユーザプロファイルのユーザライセンスが大規模ポータルユーザである場合にのみ有効です。

メモ

createPersonAccountPortalUser(user, ownerId, recordTypeId, password)

指定された recordTypeID を使用して個人取引先を作成し、サイトのポータルでその個人取引先を有効化します。

署名

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

パラメータ

user: 型: sObject
ownerId: 型: String
recordTypeId: 型: String
password: 型: String

戻り値

型: ID

使用方法

メモ

createPortalUser(user, accountId, password, sendEmailConfirmation)

指定された取引先のポータルユーザを作成し、サイトのポータルと関連付けます。

署名

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 に必要です。

このメソッドは、サイトがカスタマーポータルに関連付けられている場合にのみ有効です。

メモ

forgotPassword(username)

ユーザのパスワードをリセットし、新しいパスワードを記載したメールをユーザに送信します。パスワードのリセットが正常に行われたかどうかを示す値を返します。

署名

public static Boolean forgotPassword(String username)

パラメータ

username: 型: String

戻り値

型: Boolean

Visualforce ページの外側からコールされる場合を除き、戻り値は常に true です。Visualforce ページの外側からコールされる場合、戻り値は false です。

メモ

使用方法

getAdminEmail()

サイト管理者のメールアドレスを返します。

署名

public static String getAdminEmail()

Apex 開発者ガイド

Site クラス

名前空間

使用方法

Force.com Sites の例

Site メソッド

changePassword(newPassword, verifyNewPassword, oldPassword)

署名

パラメータ

戻り値

使用方法

createExternalUser(name, accountId)

署名

パラメータ

戻り値

使用方法

createExternalUser(name, accountId, password)

署名

パラメータ

戻り値

使用方法

createExternalUser(name, accountId, password, sendEmailConfirmation)

署名

パラメータ

戻り値

使用方法

createPersonAccountPortalUser(user, ownerId, password)

署名

パラメータ

戻り値

使用方法

createPersonAccountPortalUser(user, ownerId, recordTypeId, password)

署名

パラメータ

戻り値

使用方法

createPortalUser(user, accountId, password, sendEmailConfirmation)

署名

パラメータ

戻り値

使用方法

forgotPassword(username)

署名

パラメータ

戻り値

使用方法

getAdminEmail()

署名

戻り値

getAdminId()

署名

戻り値

getAnalyticsTrackingCode()

署名

戻り値

getCurrentSiteUrl()

署名

戻り値

使用方法

getBaseCustomUrl()

署名

戻り値

使用方法

getBaseInsecureUrl()

署名

戻り値

getBaseRequestUrl()

署名

戻り値

getBaseSecureUrl()

署名

戻り値

getBaseUrl()

署名

戻り値

使用方法

getCustomWebAddress()

署名

戻り値

使用方法