Apex 開発者ガイド
jNewer Version Available
Cookie クラス
名前空間
使用方法
PageReference クラスの setCookies メソッドを使用して、ページに Cookie を添付します。
Cookie クラスを使用する場合は、次の制限に留意してください。
- Cookie クラスには、Salesforce API バージョン 19 以降を使用して保存されている Apex を使用することでのみアクセスできます。
- Salesforce サイトドメインごとに設定できる Cookie の最大数はブラウザにより異なります。新しいブラウザは古いブラウザより高い制限が設定されています。
- Cookie は名前および属性を含め 4K 未満である必要があります。
- Visualforce ページの最大ヘッダーサイズは、Cookie を含めて 8,192 バイトです。
サイトについての詳細は、Salesforce オンラインヘルプの「Salesforce サイト」を参照してください。
例
次の例では、CookieController クラスを作成します。このクラスは Visualforce ページ (下記マークアップを参照) を使用して、ユーザにページが表示されるたびにカウンタが更新されます。ページへのアクセス回数が Cookie に保存されます。
次は、上記の CookieController Apex コントローラを使用する Visualforce ページです。アクション {!count} では、上記のコントローラで getCount メソッドをコールします。
Cookie コンストラクタ
Cookie のコンストラクタは次のとおりです。
Cookie(name, value, path, maxAge, isSecure)
指定された名前、値、パス、有効期間、およびセキュアな設定を使用して、Cookie クラスの新しいインスタンスを作成します。
署名
public Cookie(String name, String value, String path, Integer maxAge, Boolean isSecure)
Cookie(name, value, path, maxAge, isSecure, SameSite)
指定された名前、値、パス、有効期間、およびセキュリティとクロスドメインの動作の設定を使用して、Cookie クラスの新しいインスタンスを作成します。
署名
public Cookie(String name, String value, String path, Integer maxAge, Boolean isSecure, String SameSite)
パラメータ
- name
- 型: String
- Cookie 名。null にはできません。
- value
- 型: String
- Cookie データ (例: セッション ID)。
- path
- 型: String
- Cookie の取得元のパス。
- maxAge
- 型: Integer
- Cookie の有効期間を示す秒単位の数字。0 より小さく設定すると、セッション Cookie が発行されます。0 を設定すると、Cookie が削除されます。
- isSecure
- 型: Boolean
- Cookie が HTTPS でのみアクセス可能か (true)、否か (false) を示す値。
- SameSite
- 型: String
- Cookie の SameSite 属性はクロスドメインの動作を制御します。有効な値は None、Lax、Strict です。Chrome 80 リリースの後、SameSite の値が None である Cookie も、None; Secure の値を設定して、安全としてマークする必要があります。
Cookie メソッド
Cookie のメソッドは次のとおりです。すべてインスタンスメソッドです。
getMaxAge()
Cookie の有効期間を示す秒単位の数字が返されます。< 0 を設定すると、セッション Cookie が発行されます。0 を設定すると、Cookie は削除されます。
署名
public Integer getMaxAge()
戻り値
型: Integer
isSecure()
Cookie が HTTPS でのみアクセス可能な場合、true を返します。それ以外の場合は、false を返します。
署名
public Boolean isSecure()
戻り値
型: Boolean