Skip to content

Commit bb82ab4

Browse files
committed
Add missing docblocks
1 parent b425c0e commit bb82ab4

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

modules/sendgrid-sdk/handlers/webhooks.cfc

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,16 +59,33 @@ component {
5959
return replace( eventName, "_", "", "ALL" );
6060
}
6161

62+
/**
63+
* Checks if basic authentication was only partially configured.
64+
*
65+
* @returns True if the authentication credentials are only partially configured.
66+
*/
6267
private function isPartialAuthCredentials() {
6368
return ( structKeyExists( sendgridSettings, "username" ) && ! structKeyExists( sendgridSettings, "password" ) ) ||
6469
( ! structKeyExists( sendgridSettings, "username" ) && structKeyExists( sendgridSettings, "password" ) );
6570
}
6671

72+
/**
73+
* Checks if basic authentication is needed for the request.
74+
*
75+
* @returns True if the request needs authorization.
76+
*/
6777
private function needsAuth() {
6878
return structKeyExists( sendgridSettings, "username" ) ||
6979
structKeyExists( sendgridSettings, "password" );
7080
}
7181

82+
/**
83+
* Checks if the basic authentication credentials provided are valid.
84+
*
85+
* @event The ColdBox Request Context
86+
*
87+
* @returns True if the authentication credentials are invalid.
88+
*/
7289
private function isInvalidAuthCredentials( event ) {
7390
var basicAuth = event.getHTTPBasicCredentials();
7491
return ( basicAuth.username != sendgridSettings.username ||

0 commit comments

Comments
 (0)