PushoverForPS.psd1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
@{

# Script module or binary module file associated with this manifest.
RootModule = '.\PushoverForPS.psm1'

# Version number of this module.
ModuleVersion = '1.6'

# ID used to uniquely identify this module
GUID = '6fbaba4d-d67f-4afa-8283-945d6254e532'

# Author of this module
Author = 'Chris Carter'

# Company or vendor of this module
CompanyName = 'N/A'

# Copyright statement for this module
Copyright = '(c) 2016 Chris Carter. All rights reserved.'

# Description of the functionality provided by this module
Description = 'The PowerShell PushoverForPS module provides commands for interacting with the Pushover API to send notifications to Android, iOS, and desktop browsers such as Chrome, Firefox, and Safari directly from PowerShell.
 
PushoverForPS closely follows the API documentation for Pushover. It checks that all tokens, keys, and device names conform to the specified character sets. The list of availble sounds are not hard-coded; they are retrieved and stored automatically from Pushover. Any parameters that have character limitations are checked for compliance.
 
The Pushover Groups API is also fully implemented. This allows retrieving of group membership, adding and removing users from groups, enabling and disabling users temporarily, and renaming groups.
 
Commands are available for the Licensing API that allow you to assign a license to a user, and to check the remaining licenses for an application.
 
PushoverForPS also includes automatic rate limiting. According to the Pushover API, any identical requests should not be repeated within five seconds of each other. This module checks each request to ensure that it does not match a request sent within the last five seconds. If it has, it will hold the request until five seconds has elapsed.
     
Receive-PushoverReceipt can be set up to poll the Pushover API periodically as a background job to wait until the Emergency notification has been acknowledged. See Get-Help Receive-PushoverReceipt for more information.
 
For more information run Get-Help PushoverForPS.
 
To learn about Pushover, go to https://pushover.net'


# Minimum version of the Windows PowerShell engine required by this module
PowerShellVersion = '3.0'

# Functions to export from this module
FunctionsToExport = @('Send-Pushover','Test-PushoverKey','Receive-PushoverReceipt','Stop-PushoverRetry','Receive-PushoverSound','Receive-PushoverGroup','Add-PushoverUserToGroup','Remove-PushoverUserFromGroup','Disable-PushoverUser','Enable-PushoverUser','Rename-PushoverGroup','Set-PushoverLicense','Receive-PushoverLicense')

# Cmdlets to export from this module
CmdletsToExport = '*'

# Variables to export from this module
#VariablesToExport = '*'

# Aliases to export from this module
AliasesToExport = @('snpo','tspk','rcpr','sppr','rcps','rcpg','apug','rpug','dbpu','enpu','rnpg','spol','rcpl')

#Format files to be loaded when importing this module
#FormatsToProcess = ''

#Type files to be loaded when importing this module
#TypesToProcess = ''

# Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell.
PrivateData = @{

    PSData = @{

        # Tags applied to this module. These help with module discovery in online galleries.
        Tags = @('Pushover','PushoverAPI','Notifications','Android','iOS','Desktop','Chrome','Firefox','Safari')

        # A URL to the license for this module.
        LicenseUri = 'http://creativecommons.org/licenses/by-sa/4.0/'

        # A URL to the main website for this project.
        ProjectUri = 'https://gallery.technet.microsoft.com/Send-Notifications-to-aec9763a'

        # ReleaseNotes of this module
        ReleaseNotes = "There are now two commands available for the Licensing API: Set-PushoverLicense and Receive-PushoverLicense that let you assign a license to a user, and check the remaining licenses for an application respectively.
 
I'm still going back and forth on the type of the response returns from the various commands. Right now they are PSCustomObject, but I thought about making them a custom type. Plus, I also keep going back and forth about whether the properties returned should be more in line with .NET and be `$response.CalledBackAt vs their current form straight from the Pushover API, `$response.Called_Back_At. Any opinions on this would be welcome."


    } # End of PSData hashtable

} # End of PrivateData hashtable


# HelpInfo URI of this module
HelpInfoURI = ''

}