Visualforce 開発者ガイド
j$Site
現在の Salesforce サイトの情報を参照するときに使用するグローバル差し込み項目の種別です。
使用方法
現在の Salesforce サイトの情報にアクセスするには、ドット表記を使用します。次のサイト項目のみを使用できます。
| 差し込み項目 | 説明 |
|---|---|
| $Site.Name | 現在のサイトの API 参照名を返します。 |
| $Site.Domain | Salesforce サイトベースの URL を返します。 |
| $Site.CustomWebAddress | 要求のカスタム URL の末尾が force.com ではない場合はカスタム URL を返し、そうでない場合はサイトの主カスタム URL を返します。どちらも存在しない場合は、空の文字列を返します。この URL のパスは、要求のカスタム URL にパスプレフィックスがあっても、常にルートです。現在の要求がサイト要求ではない場合、この項目は空の文字列を返します。この項目の値の末尾は常に / 文字です。$Site.CustomWebAddress の使用はお勧めしません。代わりに $Site.BaseCustomUrl を使用することをお勧めします。 |
| $Site.OriginalUrl | このページがサイトに指定されたエラーページである場合は、元の URL を返し、そうでない場合は null を返します。 |
| $Site.CurrentSiteUrl | 参照やリンクで使用する必要がある、現在のサイトのベース URL を返します。この項目は、現在の要求の URL ではなく、参照元ページの URL を返す場合があります。この項目の値にはパスプレフィックスが含まれており、値の末尾は常に / 文字です。現在の要求がサイト要求ではない場合、この項目は空の文字列を返します。$Site.CurrentSiteUrl の使用はお勧めしません。代わりに $Site.BaseUrl を使用してください。 |
| $Site.LoginEnabled | 現在のサイトがログインが有効なポータルと関連付けられている場合は true を返し、そうでない場合は false を返します。 |
| $Site.RegistrationEnabled | 現在のサイトが有効なセルフ登録対応のカスタマーポータルと関連付けられている場合は true を返し、そうでない場合は false を返します。 |
| $Site.IsPasswordExpired | 認証ユーザーの場合、現在ログインしているユーザーのパスワードの有効期限が切れている場合、true を返します。認証されていないユーザーの場合は、false を返します。 |
| $Site.AdminEmailAddress | 空の文字列を返します。この差し込み項目は非推奨です。 |
| $Site.Prefix | 現在のサイトの URL パスプレフィックスを返します。たとえば、サイト URL が MyDomainName.my.salesforce-sites.com/partners である場合、/partners がパスのプレフィックスです。プレフィックスが定義されていない場合は null を返します。現在の要求がサイト要求ではない場合、この項目は空の文字列を返します。 |
| $Site.Template | 現在のサイトに関連付けられたテンプレートを返します。テンプレートが指定されていない場合、デフォルトテンプレートを返します。 |
| $Site.ErrorMessage | 現在のページがサイトに指定されたエラーページで、エラーがある場合は、現在のページのエラーメッセージを返し、そうでない場合は空の文字列を返します。 |
| $Site.ErrorDescription | 現在のページがサイトに指定されたエラーページであり、エラーがある場合は、現在のページのエラーの説明を返し、そうでない場合は空の文字列を返します。 |
| $Site.AnalyticsTrackingCode | サイトに関連付けられている追跡コード。Google アナリティクスなどのサービスは、このコードを使用してサイトのページ要求データを追跡できます。 |
| $Site.BaseCustomUrl | サブドメインが使用されていない、現在のサイトのベース URL を返します。サイトの force.com 以外のカスタム URL のうち、少なくとも 1 つが HTTPS をサポートしている場合、返された URL は、現在の要求と同じプロトコル (HTTP または HTTPS) を使用します。返された値の末尾は常に / 文字以外です。このサイトのすべてのカスタム URL の末尾が force.com か salesforce-sites.com の場合、またはこのサイトにカスタム URL がない場合、空の文字列が返されます。現在の要求がサイト要求ではない場合、このメソッドは空の文字列を返します。 この項目によって CustomWebAddress が置き換えられます。またこの項目にはカスタム URL のパスプレフィックスが含まれます。 |
| $Site.BaseInsecureUrl | この差し込み項目は非推奨です。HTTPS ではなく HTTP が使用されている、現在のサイトのベース URL を返します。現在の要求のドメインが使用されます。返された値にはパスプレフィックスが含まれており、値の末尾は常に / 文字以外です。現在の要求がサイト要求ではない場合、このメソッドは空の文字列を返します。 |
| $Site.BaseRequestUrl | 要求された URL について、現在のサイトのベース URL を返します。これは、参照元ページの URL によ���影響を受けません。返された URL は、現在の要求と同じプロトコル (HTTP または HTTPS) を使用します。返された値にはパスプレフィックスが含まれており、値の末尾は常に / 文字以外です。現在の要求がサイト要求ではない場合、このメソッドは空の文字列を返します。 |
| $Site.BaseSecureUrl | HTTP ではなく HTTPS が使用されている、現在のサイトのベース URL を返します。現在の要求のドメインが HTTPS をサポートしていれば優先されます。force.com サブドメイン以外のドメインは、force.com サブドメインよりも優先されます。force.com サブドメインは、サイトに関連付けられている場合、現在のサイトに他の HTTPS ドメインがなければ使用されます。サイトに HTTPS カスタム URL がない場合、このメソッドは空の文字列を返します。返された値にはパスプレフィックスが含まれており、値の末尾は常に / 文字以外です。現在の要求がサイト要求ではない場合、このメソッドは空の文字列を返します。 |
| $Site.BaseUrl | 参照やリンクで使用する必要がある、現在のサイトのベース URL を返します。この項目では、現在の要求の URL ではなく、参照元ページの URL を返す場合があります。この項目の値にはパスプレフィックスが含まれており、値の末尾は常に / 文字以外です。現在の要求がサイト要求ではない場合、この項目は空の文字列を返します。 $Site.CurrentSiteUrl は、この項目に置き換えられます。 |
| $Site.MasterLabel | 現在のサイトの [マスター表示ラベル] 項目の値を返します。現在の要求がサイト要求ではない場合、この項目は空の文字列を返します。 |
| $Site.SiteId | 現在のサイトの ID を返します。現在の要求がサイト要求ではない場合、この項目は空の文字列を返します。 |
| $Site.SiteType | 現在のサイトの [サイト種別] 項目の API 値を返します。現在の要求がサイト要求ではない場合、この項目は空の文字列を返します。 |
| $Site.SiteTypeLabel | 現在のサイトの [サイト種別] 項目の表示ラベル値を返します。現在の要求がサイト要求ではない場合、この項目は空の文字列を返します。 |
例
次の例では、$Site.Template 差し込み項目の使用方法を示しています。