{"__v":2,"_id":"570accd3fa088c0e006ec13d","category":{"project":"56abbf55f25f160d00e17f4e","version":"56abbf55f25f160d00e17f51","_id":"570a5676ade45d0e00c1ad33","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-04-10T13:34:46.864Z","from_sync":false,"order":3,"slug":"client-side-api","title":"Client Side API"},"parentDoc":null,"project":"56abbf55f25f160d00e17f4e","user":"56abbec30b9e0b0d00616274","version":{"__v":12,"_id":"56abbf55f25f160d00e17f51","project":"56abbf55f25f160d00e17f4e","createdAt":"2016-01-29T19:36:53.665Z","releaseDate":"2016-01-29T19:36:53.665Z","categories":["56abbf56f25f160d00e17f52","56abca6bf9757e0d007c6650","56acddfa0ab3c00d00ce3332","56af65da9d32e30d0006d30f","56af66cab34d210d003d9ad0","56af6afcd21e9c0d00b628d1","56af6d6ecc4cbd0d00ce2c88","5705b12221cfed0e00e8c580","570a5676ade45d0e00c1ad33","570d7d25d1e4b82000d9e385","570eac3c3160d10e0041df0e","575709000fd6a3200010dded"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-04-10T21:59:47.340Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":20,"body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Note\",\n  \"body\": \"This feature will not function unless we have enabled it for your game. If you would like to have this feature enabled, please email us at [apps:::at:::kongregate.com](mailto:apps@kongregate.com).\"\n}\n[/block]\n## Private Messages\n\nThis feature sends a private message from your game to the player. You simply invoke the method with the desired message content. The message will appear in the player's messages, with your game as the sender.\n\nIf you are looking to send them messages when they are not logged in to the game, look at our [Private Messages Server API](doc:server-api-private-message).\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`content`\",\n    \"0-1\": \"String\",\n    \"0-2\": \"The message to send\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"kongregate.services.privateMessage(\\\"You just did something really great!\\\");\",\n      \"language\": \"haxe\",\n      \"name\": \"ActionScript 3\"\n    },\n    {\n      \"code\": \"kongregate.services.privateMessage(\\\"You just did something really great!\\\");\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]","excerpt":"Send a private message to the user\n`privateMessage(content)`","slug":"client-api-services-privatemessage","type":"fn","title":"Services.PrivateMessage"}

fnServices.PrivateMessage

Send a private message to the user `privateMessage(content)`

[block:callout] { "type": "warning", "title": "Note", "body": "This feature will not function unless we have enabled it for your game. If you would like to have this feature enabled, please email us at [apps@kongregate.com](mailto:apps@kongregate.com)." } [/block] ## Private Messages This feature sends a private message from your game to the player. You simply invoke the method with the desired message content. The message will appear in the player's messages, with your game as the sender. If you are looking to send them messages when they are not logged in to the game, look at our [Private Messages Server API](doc:server-api-private-message). [block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Description", "0-0": "`content`", "0-1": "String", "0-2": "The message to send" }, "cols": 3, "rows": 1 } [/block] [block:code] { "codes": [ { "code": "kongregate.services.privateMessage(\"You just did something really great!\");", "language": "haxe", "name": "ActionScript 3" }, { "code": "kongregate.services.privateMessage(\"You just did something really great!\");", "language": "javascript" } ] } [/block]